Package com.aquima.interactions.portal.model.session

Class InstanceStackPortalContext

java.lang.Object

com.aquima.interactions.portal.model.session.PortalContextDelegate

com.aquima.interactions.portal.model.session.InstanceStackPortalContext

All Implemented Interfaces:

IPortalContext, IInternalPortalContext, Serializable

public class InstanceStackPortalContext
extends PortalContextDelegate
implements IInternalPortalContext

Internal portal context with an optional instance stack.

Since:

8.3

Author:

Jon van Leuven

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static IInternalPortalContext	create(IInternalPortalContext context, InstanceStack instanceStack)
IEntityInstance	getActiveInstance(String entityName)	Returns the active instance connected to the specified entity name.
IDocumentEngine	getDocumentEngine()	This method returns a document engine for the current context.
IElementComposer	getElementComposer()	This method returns an element factory that may be used to expand pre-defined elements from the composer using the current container context.
IMappingComposer	getMappingComposer()	This method returns an element factory that may be used to expand pre-defined elements from the composer using the mapping context.
InferenceContext	getProfile()	This method will return the current profile interface.
void	pushActiveInstance(IEntityInstance instance)	This method will activate the instance in the current context.

Methods inherited from class com.aquima.interactions.portal.model.session.PortalContextDelegate

forModule, forModule, getApplication, getApplicationMode, getApplicationModel, getAuditEngine, getCaseEngineClient, getCommentsManager, getCommunicationEngine, getComposer, getConfiguration, getConnectionManager, getContentManagerFactory, getContentManagerFactory, getContext, getCurrentFlow, getCurrentLanguage, getDebugger, getExpressionParser, getFactoryManager, getFlowEngine, getFlowScope, getFunctionCallDefinitionManager, getId, getMappingManager, getMaskManager, getMatchEngine, getMetaModel, getPageScope, getProcessScope, getProject, getRequestScope, getResourceManager, getRuleEngine, getServiceManager, getSessionId, getSessionScope, getState, getTraceEngine, getTreeEngine, getUserProfile, getUserScope, getWebServices, restore

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.portal.model.IInternalPortalContext

getApplication, getApplicationModel, getComposer, getConfiguration, getFactoryManager, getId

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

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

Method Details

create

public static IInternalPortalContext create(IInternalPortalContext context,
 InstanceStack instanceStack)

pushActiveInstance

public void pushActiveInstance(IEntityInstance instance)

Description copied from interface: IPortalContext

This method will activate the instance in the current context. Once an instance has been activated in a portal context, the instance will stay active until the page flow the activation occurred in has been completed.

Specified by:

pushActiveInstance in interface IPortalContext

Overrides:

pushActiveInstance in class PortalContextDelegate

Parameters:

instance - The instance that should be activated.

getProfile

public InferenceContext getProfile()

Description copied from interface: IPortalContext

This method will return the current profile interface. In addition to the standard profile behavior, the implementation returned here will also automatically inference unknown values, and is aware of the instances that might have been activated during the page flow.

See also getUserProfile()

Specified by:

getProfile in interface IPortalContext

Overrides:

getProfile in class PortalContextDelegate

Returns:

Profile interface.

getActiveInstance

public IEntityInstance getActiveInstance(String entityName)

Description copied from interface: IPortalContext

Returns the active instance connected to the specified entity name. An instance might have been activated in the following ways:

• The instance is a singleton, and therefore always active.
• The instance is activated through a container (only during page evaluation).
• The instance is activated by using the pushActiveInstance within the same flow.

Specified by:

getActiveInstance in interface IPortalContext

Overrides:

getActiveInstance in class PortalContextDelegate

Parameters:

entityName - The entity name for which the active instance is requested.

Returns:

The instance that is active for the specified entity type.

getElementComposer

public IElementComposer getElementComposer()

Description copied from interface: IPortalContext

This method returns an element factory that may be used to expand pre-defined elements from the composer using the current container context.

Specified by:

getElementComposer in interface IPortalContext

Overrides:

getElementComposer in class PortalContextDelegate

Returns:

An element factory that can be used to expand elements from the composer.

getMappingComposer

public IMappingComposer getMappingComposer()

Description copied from interface: IPortalContext

This method returns an element factory that may be used to expand pre-defined elements from the composer using the mapping context.

Specified by:

getMappingComposer in interface IPortalContext

Overrides:

getMappingComposer in class PortalContextDelegate

Returns:

An element factory that can be used to expand elements from the composer.

getDocumentEngine

public IDocumentEngine getDocumentEngine()

Description copied from interface: IPortalContext

This method returns a document engine for the current context.

Specified by:

getDocumentEngine in interface IPortalContext

Overrides:

getDocumentEngine in class PortalContextDelegate

Returns:

Document engine for the current session.