Package lumis.portal.analytics.automationflow.action

Class SendEmailActionNode

java.lang.Object

lumis.portal.analytics.automationflow.FlowNode

lumis.portal.analytics.automationflow.action.SendEmailActionNode

public class SendEmailActionNode
extends FlowNode

Action node responsible for sending e-mails.

Since:

12.1.0

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SendEmailActionNode.Addressee	A class to hold how to obtain addressee (to).
static class	SendEmailActionNode.EmailVariableDefinition	A class to hold how to obtain values for each variable.

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

FlowNode.FlowNodeExecutionResult

Field Summary

Fields

Modifier and Type	Field	Description
protected FlowNode	nextNode

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

id

Constructor Summary

Constructors

Constructor	Description
SendEmailActionNode(java.lang.String id, java.lang.String name, java.lang.String emailTemplateId, SendEmailActionNode.Addressee to, java.util.Map<java.lang.String,SendEmailActionNode.EmailVariableDefinition> variables, FlowNode nextNode)	Creates a new instance.
SendEmailActionNode(org.json.JSONObject object, FlowEntry flowEntry)	Creates a new instance from configuration.

Method Summary

Modifier and Type	Method	Description
FlowNode.FlowNodeExecutionResult	execute(FlowContext flowContext)	Executes this node and returns the next node to be executed.
java.util.Collection<FlowNode>	getFollowUps()	Returns all possible follow up nodes.
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

Field Detail

nextNode

protected final FlowNode nextNode

Constructor Detail

SendEmailActionNode

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

Creates a new instance from configuration.

Parameters:

object - the JSON object

flowEntry - the flow entry

Since:

12.1.0

SendEmailActionNode

public SendEmailActionNode(java.lang.String id,
                           java.lang.String name,
                           java.lang.String emailTemplateId,
                           SendEmailActionNode.Addressee to,
                           java.util.Map<java.lang.String,SendEmailActionNode.EmailVariableDefinition> variables,
                           FlowNode nextNode)

Creates a new instance.

Parameters:

id - the identifier.

name - the name.

Since:

12.1.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 class FlowNode

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 class FlowNode

Parameters:

checkAllNextNodes - check all next nodes nodes.

Returns:

true if all variable state is OK.

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.