Class RemoveUserFromJourneyActionNode
- java.lang.Object
-
- lumis.portal.analytics.automationflow.FlowNode
-
- lumis.portal.analytics.automationflow.action.RemoveUserFromJourneyActionNode
-
public class RemoveUserFromJourneyActionNode extends FlowNode
Removes the flow context's user from the given journey.- Since:
- 12.2.0
- Version:
- $Revision: 24428 $ $Date: 2021-03-22 13:20:52 -0300 (Mon, 22 Mar 2021) $
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class lumis.portal.analytics.automationflow.FlowNode
FlowNode.FlowNodeExecutionResult
-
-
Constructor Summary
Constructors Constructor Description RemoveUserFromJourneyActionNode(String id, String name, String journeyId, FlowNode nextNode)
Creates a new instance.RemoveUserFromJourneyActionNode(org.json.JSONObject object, FlowEntry flowEntry)
Creates a new instance from the given JSON configuration object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowNode.FlowNodeExecutionResult
execute(FlowContext flowContext)
Executes this node and returns the next node to be executed.Collection<FlowNode>
getFollowUps()
Returns all possible follow up nodes.String
getJourneyId()
Returns the journeyId.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
-
-
-
-
Field Detail
-
nextNode
protected final FlowNode nextNode
-
-
Constructor Detail
-
RemoveUserFromJourneyActionNode
public RemoveUserFromJourneyActionNode(org.json.JSONObject object, FlowEntry flowEntry)
Creates a new instance from the given JSON configuration object.- Parameters:
object
- the JSON configuration objectflowEntry
- 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.- 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 classFlowNode
- Parameters:
flowContext
- the flow context- Returns:
- the next node to be executed
- 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.- Specified by:
validateStateAndLog
in classFlowNode
- Parameters:
checkAllNextNodes
- check all next nodes nodes.- Returns:
- true if all variable state is OK.
-
getJourneyId
public String getJourneyId()
Returns the journeyId.- Returns:
- the journeyId
- Since:
- 12.2.0
-
getFollowUps
public Collection<FlowNode> getFollowUps()
Description copied from class:FlowNode
Returns all possible follow up nodes.- Overrides:
getFollowUps
in classFlowNode
- Returns:
- all possible follow up nodes.
-
-