Package de.uplanet.lucy.server.websocket.workflow.action

Class WebSocketWorkflowAction.DataCfg

java.lang.Object

de.uplanet.lucy.server.websocket.workflow.action.WebSocketWorkflowAction.DataCfg

All Implemented Interfaces:

IContextVariableNameDataProp, IDataFieldGuidDataProp, IDataProp

Enclosing class:

WebSocketWorkflowAction

public static final class WebSocketWorkflowAction.DataCfg
extends Object
implements IContextVariableNameDataProp, IDataFieldGuidDataProp

Constructor Summary

Constructors

Constructor	Description
DataCfg()

Method Summary

Modifier and Type	Method	Description
String	getContextVariableName()	Get the name of the context variable that contains the payload data.
String	getDataFieldGuid()	Get the GUID of the data field that contains the payload data.
ON_ERROR_MODE	getOnErrorMode()
String	getTextPath()
String	getVelocityPath()
boolean	hasContextVariableName()
boolean	hasDataFieldGuid()
boolean	hasVelocityPath()
void	setContextVariableName(String p_strContextVariableName)	Set the name of the context variable that contains the payload data.
void	setDataFieldGuid(String p_strDataFieldGuid)	Set the GUID of the data field that contains the payload data.
void	setOnErrorMode(ON_ERROR_MODE p_onErrorMode)
void	setTextPath(String p_strTextPath)
void	setVelocityPath(String p_strVelocityPath)

Methods inherited from class java.lang.Object

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

Constructor Details

DataCfg

public DataCfg()

Method Details

getTextPath

public String getTextPath()

setTextPath

public void setTextPath(String p_strTextPath)

hasVelocityPath

public boolean hasVelocityPath()

getVelocityPath

public String getVelocityPath()

setVelocityPath

public void setVelocityPath(String p_strVelocityPath)

getOnErrorMode

public ON_ERROR_MODE getOnErrorMode()

setOnErrorMode

public void setOnErrorMode(ON_ERROR_MODE p_onErrorMode)

getContextVariableName

public String getContextVariableName()

Description copied from interface: IContextVariableNameDataProp

Get the name of the context variable that contains the payload data.

Existing prefixes are

• URN_REQUEST_PREFIX
• URN_SESSION_PREFIX
• URN_SHARED_STATE_PREFIX
• URN_USER_PREFIX
• URN_SYSTEM_DATA_GROUP_PREFIX

Note that not all prefixes are available in all contexts.

Specified by:

getContextVariableName in interface IContextVariableNameDataProp

Returns:

The name of the context variable, or null.

See Also:

• VARIABLE_NAMESPACE.URN_REQUEST_PREFIX
• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX
• VARIABLE_NAMESPACE.URN_USER_PREFIX
• VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

setContextVariableName

public void setContextVariableName(String p_strContextVariableName)

Description copied from interface: IContextVariableNameDataProp

Set the name of the context variable that contains the payload data.

Existing prefixes are

• URN_REQUEST_PREFIX
• URN_SESSION_PREFIX
• URN_SHARED_STATE_PREFIX
• URN_USER_PREFIX
• URN_SYSTEM_DATA_GROUP_PREFIX

Note that not all prefixes are available in all contexts.

Specified by:

setContextVariableName in interface IContextVariableNameDataProp

Parameters:

p_strContextVariableName - The name of the context variable.

See Also:

• VARIABLE_NAMESPACE.URN_REQUEST_PREFIX
• VARIABLE_NAMESPACE.URN_SESSION_PREFIX
• VARIABLE_NAMESPACE.URN_SHARED_STATE_PREFIX
• VARIABLE_NAMESPACE.URN_USER_PREFIX
• VARIABLE_NAMESPACE.URN_SYSTEM_DATA_GROUP_PREFIX

hasContextVariableName

public boolean hasContextVariableName()

getDataFieldGuid

public String getDataFieldGuid()

Description copied from interface: IDataFieldGuidDataProp

Get the GUID of the data field that contains the payload data.

Specified by:

getDataFieldGuid in interface IDataFieldGuidDataProp

Returns:

The GUID of the data field, or null.

setDataFieldGuid

public void setDataFieldGuid(String p_strDataFieldGuid)

Description copied from interface: IDataFieldGuidDataProp

Set the GUID of the data field that contains the payload data.

Specified by:

setDataFieldGuid in interface IDataFieldGuidDataProp

Parameters:

p_strDataFieldGuid - The GUID of the data field.

hasDataFieldGuid

public boolean hasDataFieldGuid()