Package com.aquima.interactions.portal.model.tx

Class ProfileContext

java.lang.Object

com.aquima.interactions.portal.model.tx.ProfileContext

All Implemented Interfaces:

IInstanceContext, Serializable

public class ProfileContext
extends Object
implements IInstanceContext

Root context for the active instances. This context forwards all calls to getActiveInstance to the profile.

Since:

5.0

Author:

O. Kerpershoek

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProfileContext(TmsProfile profile)	Constructs the profile context for the specified profile.

Method Summary

Modifier and Type	Method	Description
IEntityInstance	getActiveInstance(String entityName)	This method returns the active instance for the specified entity type.
String	getId()	This method returns a unique ID for the instance context.
IInstanceContext	getParentContext()	This method returns the parent context of this context.
IEntityInstance	popActiveInstance()	This method will de-activate the last activated instance.
void	pushActiveInstance(IEntityInstance instance)	This method will activate the specified instance within this context.

Methods inherited from class java.lang.Object

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

Constructor Details

ProfileContext

public ProfileContext(TmsProfile profile)

Constructs the profile context for the specified profile.

Parameters:

profile - The profile for which the context is created.

Method Details

getId

public String getId()

Description copied from interface: IInstanceContext

This method returns a unique ID for the instance context. This ID can for instance the the name of the page of the flow the context belongs to.

Specified by:

getId in interface IInstanceContext

Returns:

a unique ID for the instance context.

getParentContext

public IInstanceContext getParentContext()

Description copied from interface: IInstanceContext

This method returns the parent context of this context. The parent context is available when nested contexts are used. For instance when the flow context will have a page context as parent.

Specified by:

getParentContext in interface IInstanceContext

Returns:

the parent context of this context.

getActiveInstance

public IEntityInstance getActiveInstance(String entityName)

Description copied from interface: IInstanceContext

This method returns the active instance for the specified entity type.

Specified by:

getActiveInstance in interface IInstanceContext

Parameters:

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

Returns:

The active instance for the specified entity type.

popActiveInstance

public IEntityInstance popActiveInstance()

Description copied from interface: IInstanceContext

This method will de-activate the last activated instance.

Specified by:

popActiveInstance in interface IInstanceContext

Returns:

The instance that was de-actived.

pushActiveInstance

public void pushActiveInstance(IEntityInstance instance)

Description copied from interface: IInstanceContext

This method will activate the specified instance within this context.

Specified by:

pushActiveInstance in interface IInstanceContext

Parameters:

instance - The instance that should be made active.