Package com.aquima.interactions.framework.handler.messages

Class GetMessageHandler

java.lang.Object

com.aquima.interactions.framework.handler.messages.GetMessageHandler

All Implemented Interfaces:

IActionHandler

public class GetMessageHandler
extends Object
implements IActionHandler

Action handler that retrieves a message for the specified as parameter.

Since:

5.0

Author:

Jon van Leuven

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	This member defines the default name for the action handler.
static final String	PARAM_MESSAGE_KEY	This member defines the key of parameter specifying the message whose text should be retrieved.

Constructor Summary

Constructors

Constructor	Description
GetMessageHandler()

Method Summary

Modifier and Type	Method	Description
IActionResult	handle(IActionContext context)	This method will be called from the portal session to handle an action request from the client.
boolean	isReadOnly()	This method indicates if the action handler does not modify any profile data.

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

This member defines the default name for the action handler.

See Also:

• Constant Field Values

PARAM_MESSAGE_KEY

public static final String PARAM_MESSAGE_KEY

This member defines the key of parameter specifying the message whose text should be retrieved.

See Also:

• Constant Field Values

Constructor Details

GetMessageHandler

public GetMessageHandler()

Method Details

handle

public IActionResult handle(IActionContext context)
                     throws PortalException

Description copied from interface: IActionHandler

This method will be called from the portal session to handle an action request from the client. The method returns an Action result object which can be used by the client to act upon this result.

Specified by:

handle in interface IActionHandler

Parameters:

context - The portal context of the current session.

Returns:

The result of the handle method, may be null.

Throws:

PortalException - This exception may be thrown by the implementation to indicate a failure.

isReadOnly

public boolean isReadOnly()

Description copied from interface: IActionHandler

This method indicates if the action handler does not modify any profile data.

Specified by:

isReadOnly in interface IActionHandler

Returns:

boolean indicating if the handler does not modify any profile data.