Package lumis.portal.analytics.automationflow.condition

Class AbstractUserInJourneyChoiceNode

java.lang.Object

lumis.portal.analytics.automationflow.FlowNode

lumis.portal.analytics.automationflow.condition.TrueFalseNode

lumis.portal.analytics.automationflow.condition.AbstractUserInJourneyChoiceNode

Direct Known Subclasses:

UserInJourneyChoiceNode, UserInJourneyStageChoiceNode

public abstract class AbstractUserInJourneyChoiceNode
extends TrueFalseNode

Choice node that splits the flow depending whether the user is on a given journey or journey instance.

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
AbstractUserInJourneyChoiceNode(java.lang.String id, java.lang.String name, java.lang.String journeyEntityId, FlowNode trueNode, FlowNode falseNode)	Creates a new instance.
AbstractUserInJourneyChoiceNode(org.json.JSONObject object, FlowEntry flowEntry)	Creates a new instance from the given JSON configuration object.

Method Summary

Modifier and Type	Method	Description
boolean	evaluate(FlowContext flowContext)	Evaluates the given flow context.
java.lang.String	getJourneyEntityId()	Returns this node journey entity identifier.
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.condition.TrueFalseNode

addFalseNodeToJson, addTrueNodeToJson, execute, getFalseNodeFromJson, getFollowUps, getTrueNodeFromJson

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

AbstractUserInJourneyChoiceNode

public AbstractUserInJourneyChoiceNode(java.lang.String id,
                                       java.lang.String name,
                                       java.lang.String journeyEntityId,
                                       FlowNode trueNode,
                                       FlowNode falseNode)

Creates a new instance.

Parameters:

id - the node identifier

name - the node name

journeyEntityId - the journey or journey stage identifier

trueNode - the truthy follow-up

falseNode - the falsy follow-up

Since:

12.2.0

AbstractUserInJourneyChoiceNode

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

Creates a new instance from the given JSON configuration object.

Parameters:

object - the JSON configuration object

flowEntry - the flow entry

Since:

12.2.0

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 TrueFalseNode

Returns:

the JSON representation of this node.

evaluate

public boolean evaluate(FlowContext flowContext)
                 throws PortalException

Description copied from class: TrueFalseNode

Evaluates the given flow context. Returns true if the context matches the condition or false otherwise.

Specified by:

evaluate in class TrueFalseNode

Parameters:

flowContext - the context

Returns:

true if the context matches the condition or false otherwise.

Throws:

PortalException

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.

Overrides:

validateStateAndLog in class TrueFalseNode

Parameters:

checkAllNextNodes - check all next nodes nodes.

Returns:

true if all variable state is OK.

getJourneyEntityId

public java.lang.String getJourneyEntityId()

Returns this node journey entity identifier.

Returns:

this node journey entity identifier.

Since:

12.2.0