Package lumis.portal.analytics.automationflow.action

Class WaitForEventActionNode

java.lang.Object

lumis.portal.analytics.automationflow.FlowNode

lumis.portal.analytics.automationflow.action.WaitForEventActionNode

public class WaitForEventActionNode
extends FlowNode

The wait for event node.

Since:

12.2.0

Version:

$Revision$ $Date$

Nested Class Summary

Nested classes/interfaces inherited from class lumis.portal.analytics.automationflow.FlowNode

FlowNode.FlowNodeExecutionResult

Field Summary

Fields inherited from class lumis.portal.analytics.automationflow.FlowNode

id

Constructor Summary

Constructors

Constructor	Description
WaitForEventActionNode(java.lang.String id, java.lang.String name, FlowNode resumeNode, FlowNode timeoutNode, java.util.concurrent.TimeUnit timeoutUnit, java.lang.Integer timeoutAmount, EventFilterData eventFilterData)
WaitForEventActionNode(org.json.JSONObject object, FlowEntry flowEntry)

Method Summary

Modifier and Type	Method	Description
FlowNode.FlowNodeExecutionResult	execute(FlowContext flowContext)	Executes this node and returns the next node to be executed.
EventFilterData	getEventFilterData()	Returns the eventFilterData.
java.util.Collection<FlowNode>	getFollowUps()	Returns all possible follow up nodes.
FlowNode	getResumeNode()	Returns the resume node.
java.lang.Integer	getTimeoutAmount()	Returns the timeoutAmount.
FlowNode	getTimeoutNode()	Returns the timeout node.
java.util.concurrent.TimeUnit	getTimeoutUnit()	Returns the timeoutUnit.
java.lang.String	getWaitingEventId()	Returns the waiting event identifier of self node.
org.json.JSONObject	toJSONObject()	Returns the JSON representation of this node.
boolean	validateStateAndLog(boolean checkAllNextNodes)	To permit edition when JSON flow is saved incorrectly in data base, the flow node constructor by JSON parameter need allows to load flow node variables without exception when something already is wrong.

Methods inherited from class lumis.portal.analytics.automationflow.FlowNode

getAndValidateNotAnonymousUser, getFlowEntry, getId, getName, getNodeLogLabel, init, logError, logError

Methods inherited from class java.lang.Object

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

Constructor Detail

WaitForEventActionNode

public WaitForEventActionNode(java.lang.String id,
                              java.lang.String name,
                              FlowNode resumeNode,
                              FlowNode timeoutNode,
                              java.util.concurrent.TimeUnit timeoutUnit,
                              java.lang.Integer timeoutAmount,
                              EventFilterData eventFilterData)

WaitForEventActionNode

public WaitForEventActionNode(org.json.JSONObject object,
                              FlowEntry flowEntry)

Method Detail

toJSONObject

public org.json.JSONObject toJSONObject()

Description copied from class: FlowNode

Returns the JSON representation of this node. This method is the counterpart of #FlowNode(JSONObject) constructor.

Overrides:

toJSONObject in class FlowNode

Returns:

the JSON representation of this node.

execute

public FlowNode.FlowNodeExecutionResult execute(FlowContext flowContext)
                                         throws PortalException

Description copied from class: FlowNode

Executes this node and returns the next node to be executed.

Specified by:

execute in class FlowNode

Parameters:

flowContext - the flow context

Returns:

the next node to be executed

Throws:

PortalException

getWaitingEventId

public java.lang.String getWaitingEventId()
                                   throws PortalException

Returns the waiting event identifier of self node.

Returns:

the waiting event identifier of self node.

Throws:

PortalException

Since:

12.2.0

validateStateAndLog

public boolean validateStateAndLog(boolean checkAllNextNodes)

Description copied from class: FlowNode

To permit edition when JSON flow is saved incorrectly in data base, the flow node constructor by JSON parameter need allows to load flow node variables without exception when something already is wrong. So, to prevents exception on flow node execution and prevent to save flow when flow node is invalid state, this methods will check if all variables is OK and log otherwise.

Specified by:

validateStateAndLog in class FlowNode

Parameters:

checkAllNextNodes - check all next nodes nodes.

Returns:

true if all variable state is OK.

getResumeNode

public FlowNode getResumeNode()

Returns the resume node.

Returns:

the resume node.

Since:

12.2.0

getTimeoutNode

public FlowNode getTimeoutNode()

Returns the timeout node.

Returns:

the timeout node.

Since:

12.2.0

getTimeoutUnit

public java.util.concurrent.TimeUnit getTimeoutUnit()

Returns the timeoutUnit.

Returns:

the timeoutUnit

Since:

12.2.0

getTimeoutAmount

public java.lang.Integer getTimeoutAmount()

Returns the timeoutAmount.

Returns:

the timeoutAmount

Since:

12.2.0

getFollowUps

public java.util.Collection<FlowNode> getFollowUps()

Description copied from class: FlowNode

Returns all possible follow up nodes.

Overrides:

getFollowUps in class FlowNode

Returns:

all possible follow up nodes.

getEventFilterData

public EventFilterData getEventFilterData()

Returns the eventFilterData.

Returns:

the eventFilterData

Since:

12.2.0