Package de.mhus.lib.portlet.callback

Class CallContext

java.lang.Object

de.mhus.lib.portlet.callback.CallContext

All Implemented Interfaces:

de.mhus.lib.core.util.MNlsProvider

public class CallContext
extends Object
implements de.mhus.lib.core.util.MNlsProvider

CallContext class.

Version:

$Id: $Id

Author:

mikehummel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CallContext.Alert

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_DATA_NAME	Constant DEFAULT_DATA_NAME="data"

Constructor Summary

Constructors

Constructor	Description
CallContext(AbstractAjaxCallback callback, javax.portlet.ResourceRequest request, com.fasterxml.jackson.core.JsonGenerator response)	Constructor for CallContext.

Method Summary

Modifier and Type	Method	Description
void	addAlert(CallContext.Alert alert, boolean useNls)	addAlert.
void	addError(String error)	addError.
void	addInforamtion(String info)	addInforamtion.
com.fasterxml.jackson.databind.node.ObjectNode	addResult()	addResult.
void	addSuccess(String msg)	addSuccess.
void	addWarning(String warning)	addWarning.
void	doSend()	doSend.
com.fasterxml.jackson.databind.JsonNode	getData()	getData.
com.fasterxml.jackson.databind.JsonNode	getData(String attributeName)	getData.
de.mhus.lib.core.util.MNls	getNls()
de.mhus.lib.core.IProperties	getProperties()	Getter for the field properties.
javax.portlet.ResourceRequest	getRequest()	Getter for the field request.
javax.portlet.PortletSession	getSession()	getSession.
de.mhus.lib.core.logging.Log	log()	log.
void	setNls(de.mhus.lib.core.util.MNls mNls)	Setter for the field nls.
void	setRuntimeError(Throwable t)	setRuntimeError.
void	setSuccess(boolean success)	Setter for the field success.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_DATA_NAME

public static final String DEFAULT_DATA_NAME

Constant DEFAULT_DATA_NAME="data"

See Also:

Constant Field Values

Constructor Detail

CallContext

public CallContext(AbstractAjaxCallback callback,
                   javax.portlet.ResourceRequest request,
                   com.fasterxml.jackson.core.JsonGenerator response)

Constructor for CallContext.

Parameters:

callback - a AbstractAjaxCallback object.

request - a ResourceRequest object.

response - a JsonGenerator object.

Method Detail

addSuccess

public void addSuccess(String msg)

addSuccess.

Parameters:

msg - a String object.

addError

public void addError(String error)

addError.

Parameters:

error - a String object.

addWarning

public void addWarning(String warning)

addWarning.

Parameters:

warning - a String object.

addInforamtion

public void addInforamtion(String info)

addInforamtion.

Parameters:

info - a String object.

addAlert

public void addAlert(CallContext.Alert alert,
                     boolean useNls)

addAlert.

Parameters:

alert - a CallContext.Alert object.

useNls - a boolean.

setRuntimeError

public void setRuntimeError(Throwable t)

setRuntimeError.

Parameters:

t - a Throwable object.

setSuccess

public void setSuccess(boolean success)

Setter for the field success.

Parameters:

success - a boolean.

doSend

public void doSend()

doSend.

getNls

public de.mhus.lib.core.util.MNls getNls()

Specified by:

getNls in interface de.mhus.lib.core.util.MNlsProvider

setNls

public void setNls(de.mhus.lib.core.util.MNls mNls)

Setter for the field nls.

Parameters:

mNls - a MNls object.

getRequest

public javax.portlet.ResourceRequest getRequest()

Getter for the field request.

Returns:

a ResourceRequest object.

log

public de.mhus.lib.core.logging.Log log()

log.

Returns:

a Log object.

addResult

public com.fasterxml.jackson.databind.node.ObjectNode addResult()

addResult.

Returns:

a ObjectNode object.

getSession

public javax.portlet.PortletSession getSession()

getSession.

Returns:

a PortletSession object.

getProperties

public de.mhus.lib.core.IProperties getProperties()

Getter for the field properties.

Returns:

a IProperties object.

getData

public com.fasterxml.jackson.databind.JsonNode getData()
                                                throws de.mhus.lib.errors.MException

getData.

Returns:

a JsonNode object.

Throws:

de.mhus.lib.errors.MException - if any.

getData

public com.fasterxml.jackson.databind.JsonNode getData(String attributeName)
                                                throws de.mhus.lib.errors.MException

getData.

Parameters:

attributeName - a String object.

Returns:

a JsonNode object.

Throws:

de.mhus.lib.errors.MException - if any.