Package com.aquima.interactions.portal

Interface IContainerEventContext

All Superinterfaces:

IEventContext, IPortalContext, Serializable

All Known Implementing Classes:

CallbackContext

public interface IContainerEventContext
extends IEventContext

Context that is used in the handle of a dynamic container.

Since:

5.1

Author:

O. Kerpershoek

Method Summary

Modifier and Type	Method	Description
String	getContainerName()	This method will return the name of the container that the dynamic container component was applied to.
String	getParameter(String name)	This method will return the value for the parameter with the specified name.
ITypedParameters	getParameters()	This method will return all the parameters defined for the container at once in a single object.

Methods inherited from interface com.aquima.interactions.portal.IEventContext

addErrorMessage, addErrorText, addWarningMessage, addWarningText, clearErrors, getErrors, getErrors, getEvent, getStopOnErrors, hasErrors, isFlowBlocked, setFlowBlocked, setFocus, setStopOnErrors

Methods inherited from interface com.aquima.interactions.portal.IPortalContext

forModule, forModule, getActiveInstance, getApplicationMode, getAuditEngine, getCaseEngineClient, getCommentsManager, getCommunicationEngine, getConnectionManager, getContentManagerFactory, getContentManagerFactory, getCurrentFlow, getCurrentLanguage, getDebugger, getDocumentEngine, getElementComposer, getExpressionParser, getFlowEngine, getFlowScope, getFunctionCallDefinitionManager, getMappingComposer, getMappingManager, getMaskManager, getMatchEngine, getMetaModel, getPageScope, getProcessScope, getProfile, getProject, getRequestScope, getResourceManager, getRuleEngine, getServiceManager, getSessionId, getSessionScope, getState, getTraceEngine, getTreeEngine, getUserProfile, getUserScope, getWebServices, pushActiveInstance, restore

Method Details

getContainerName

String getContainerName()

This method will return the name of the container that the dynamic container component was applied to. This name is thus equal to the name of the container as defined in the Everest Studio.

Returns:

The name of the container.

getParameter

String getParameter(String name)

This method will return the value for the parameter with the specified name. When no value was found for the given name, the null value will be returned.

Parameters:

name - String containing the name of the parameter for which the value is requested.

Returns:

The value of the parameter for the specified name.

getParameters

ITypedParameters getParameters()

This method will return all the parameters defined for the container at once in a single object.

Returns:

Object containing all the parameters for the container.