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

Class PortalMessageScope

java.lang.Object

com.aquima.interactions.portal.model.session.scope.PortalScope

com.aquima.interactions.portal.model.session.scope.PortalMessageScope

All Implemented Interfaces:

IPortalMessageScope, IPortalScope, Serializable

Direct Known Subclasses:

PageScope, SessionScope

public abstract class PortalMessageScope
extends PortalScope
implements IPortalMessageScope

Portal Message scope implementation.

Since:

9.2

Author:

A.Pragt

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PortalMessageScope()
protected	PortalMessageScope(PortalMessageScope parent)

Method Summary

Modifier and Type	Method	Description
void	clearPortalMessageAction(String portalMessage)	Clears the current action to the specified portal message.
String[]	getMappedPortalMessages()	Returns the portalMessages for which a mapping is defined.
PortalMessageAction	getPortalMessageAction(String portalMessage)	Returns the current action for the specified portal message.
void	setPortalMessageAction(String portalMessage, PortalMessageAction action)	Sets the action to the specified portal message.

Methods inherited from class com.aquima.interactions.portal.model.session.scope.PortalScope

clearAttribute, destroyDisposableObjects, discardParent, getAttribute, getAttributeNames, getParentScope, hasAttribute, isCleared, mergeWithParent, setAttribute

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.IPortalScope

clearAttribute, getAttribute, getAttributeNames, getType, hasAttribute, setAttribute

Constructor Details

PortalMessageScope

protected PortalMessageScope()

PortalMessageScope

protected PortalMessageScope(PortalMessageScope parent)

Method Details

getMappedPortalMessages

public String[] getMappedPortalMessages()

Description copied from interface: IPortalMessageScope

Returns the portalMessages for which a mapping is defined.

Specified by:

getMappedPortalMessages in interface IPortalMessageScope

Returns:

The names of the mapped portal messages, not null.

setPortalMessageAction

public void setPortalMessageAction(String portalMessage,
 PortalMessageAction action)

Description copied from interface: IPortalMessageScope

Sets the action to the specified portal message.

Specified by:

setPortalMessageAction in interface IPortalMessageScope

Parameters:

portalMessage - The portal message to map, not null or empty.

action - The action to perform on the message, not null.

clearPortalMessageAction

public void clearPortalMessageAction(String portalMessage)

Description copied from interface: IPortalMessageScope

Clears the current action to the specified portal message.

Specified by:

clearPortalMessageAction in interface IPortalMessageScope

Parameters:

portalMessage - The portal message to clear, not null or empty.

getPortalMessageAction

public PortalMessageAction getPortalMessageAction(String portalMessage)

Description copied from interface: IPortalMessageScope

Returns the current action for the specified portal message.

Specified by:

getPortalMessageAction in interface IPortalMessageScope

Parameters:

portalMessage - The portal message to retrieve the action for, not null or empty.

Returns:

The current action.