Package com.aquima.interactions.portal

Class PortalMessageAction

java.lang.Object

com.aquima.interactions.portal.PortalMessageAction

All Implemented Interfaces:

Serializable

public class PortalMessageAction
extends Object
implements Serializable

The class describes the action for a portal message.

Since:

9.2

Author:

A.Pragt

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PortalMessageAction()

Method Summary

Modifier and Type	Method	Description
Map<String,Serializable>	execute(IPortalMessage message, IActionContext context)	Executes this action by mapping the fields of the portal message to attributes.
static PortalMessageAction	forRestart()
AttributeReference	getFieldMapping(String fieldName)	Returns the target attribute for a data field.
void	setFieldMapping(String fieldName, AttributeReference attribute)	Adds a mapping of a message field to an attribute.

Methods inherited from class java.lang.Object

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

Constructor Details

PortalMessageAction

public PortalMessageAction()

Method Details

forRestart

public static PortalMessageAction forRestart()

setFieldMapping

public void setFieldMapping(String fieldName,
 AttributeReference attribute)

Adds a mapping of a message field to an attribute.

Parameters:

fieldName - The name of the field, not null.

attribute - The target attribute, not null.

getFieldMapping

public AttributeReference getFieldMapping(String fieldName)

Returns the target attribute for a data field.

Parameters:

fieldName - The name of the field, not null.

Returns:

The target attribute, never null.

execute

public Map<String,Serializable> execute(IPortalMessage message,
 IActionContext context)

Executes this action by mapping the fields of the portal message to attributes.

Parameters:

message - the portal message whose fields are to be mapped

context - contextual information required to perform the mapping

Returns:

a map that can be used as flow parameters for the restarted flow