Package de.elo.ix.client
Class StartAdHocWorkflowInfo
java.lang.Object
de.elo.ix.client.StartAdHocWorkflowInfo
- All Implemented Interfaces:
java.io.Serializable
public class StartAdHocWorkflowInfo
extends java.lang.Object
implements java.io.Serializable
This class contains several options that are used to start the AdHocWorkflow
- Since:
- 9.00.000.038
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
acceptMessage
This message is shown if the workflow is accepted by a person.protected java.lang.String
actionRejectMessage
This message is shown if the workflow is rejected.protected java.lang.String
breakWorkflowMessage
This message is send to the user who started the workflow if the workflow is canceled.protected java.lang.String
cancelMessage
The message that is send to the user specified withcancelUserId
, if the workflow is canceled.protected java.lang.String
cancelUserId
If the workflow is canceled, this user receives a message,cancelMessage
.protected boolean
deactivateNodes
If true, all person nodes are deactivated when the workflow is canceled.protected java.lang.String
finishedMessage
The message that is send to the user specified withfinishedUserId
, if the workflow is finished.protected java.lang.String
finishedScript
This script is executed, when the workflow is finished.protected java.lang.String
finishedUserId
If the workflow is finished, this user receives a message,finishedMessage
.protected int
flags
Control flags for the node, a combination of WFNode.C.FLAG_* constants.protected boolean
forValidation
If true, the workflow comes back to the user who started it.protected java.util.List<ValueClass>
nodeInfos
The information of all nodes in the workflow.protected java.lang.String
nodeName
Start node name.protected java.lang.String
noticeMessage
This message is shown if the a person was informed about the workflow.protected boolean
serialFlow
If true, the workflow routes the object from user to user.protected java.lang.String
successMessage
This message is shown if the workflow is successfully processed.protected WFTimeLimit
timeLimit
Time-limit for the entire workflow.protected WFTimeLimit[]
timeLimitEscalations
Additional definitions for time limits.protected java.lang.String[]
userIdsToDeactivate
The list of the person nodes to be deactivated when the workflow is canceled.protected java.lang.String
workflowRepeatMessage
This message is send to the user who started the workflow if the workflow is repeated. -
Constructor Summary
Constructors Constructor Description StartAdHocWorkflowInfo()
StartAdHocWorkflowInfo(StartAdHocWorkflowInfo rhs)
-
Method Summary
Modifier and Type Method Description java.lang.String
getAcceptMessage()
java.lang.String
getActionRejectMessage()
java.lang.String
getBreakWorkflowMessage()
java.lang.String
getCancelMessage()
java.lang.String
getCancelUserId()
java.lang.String
getFinishedMessage()
java.lang.String
getFinishedScript()
java.lang.String
getFinishedUserId()
int
getFlags()
java.util.List<ValueClass>
getNodeInfos()
java.lang.String
getNodeName()
java.lang.String
getNoticeMessage()
java.lang.String
getSuccessMessage()
WFTimeLimit
getTimeLimit()
WFTimeLimit[]
getTimeLimitEscalations()
java.lang.String[]
getUserIdsToDeactivate()
java.lang.String
getWorkflowRepeatMessage()
boolean
isDeactivateNodes()
boolean
isForValidation()
boolean
isSerialFlow()
void
setAcceptMessage(java.lang.String acceptMessage)
void
setActionRejectMessage(java.lang.String actionRejectMessage)
void
setBreakWorkflowMessage(java.lang.String breakWorkflowMessage)
void
setCancelMessage(java.lang.String cancelMessage)
void
setCancelUserId(java.lang.String cancelUserId)
void
setDeactivateNodes(boolean deactivateNodes)
void
setFinishedMessage(java.lang.String finishedMessage)
void
setFinishedScript(java.lang.String finishedScript)
void
setFinishedUserId(java.lang.String finishedUserId)
void
setFlags(int flags)
void
setForValidation(boolean forValidation)
void
setNodeInfos(java.util.List<ValueClass> nodeInfos)
void
setNodeName(java.lang.String nodeName)
void
setNoticeMessage(java.lang.String noticeMessage)
void
setSerialFlow(boolean serialFlow)
void
setSuccessMessage(java.lang.String successMessage)
void
setTimeLimit(WFTimeLimit timeLimit)
void
setTimeLimitEscalations(WFTimeLimit[] timeLimitEscalation)
void
setUserIdsToDeactivate(java.lang.String[] userIdsToDeactivate)
void
setWorkflowRepeatMessage(java.lang.String workflowRepeatMessage)
java.lang.String
toString()
-
Field Details
-
forValidation
protected boolean forValidationIf true, the workflow comes back to the user who started it. -
serialFlow
protected boolean serialFlowIf true, the workflow routes the object from user to user. The workflow finishes when the last user has edited their node. IfserialFlow
is false, the workflow routes the object to all users. The first user who edits their node terminates the workflow. -
cancelUserId
protected java.lang.String cancelUserIdIf the workflow is canceled, this user receives a message,cancelMessage
. -
cancelMessage
protected java.lang.String cancelMessageThe message that is send to the user specified withcancelUserId
, if the workflow is canceled. -
finishedUserId
protected java.lang.String finishedUserIdIf the workflow is finished, this user receives a message,finishedMessage
. -
finishedMessage
protected java.lang.String finishedMessageThe message that is send to the user specified withfinishedUserId
, if the workflow is finished. -
finishedScript
protected java.lang.String finishedScriptThis script is executed, when the workflow is finished. -
nodeName
protected java.lang.String nodeNameStart node name. -
workflowRepeatMessage
protected java.lang.String workflowRepeatMessageThis message is send to the user who started the workflow if the workflow is repeated. -
breakWorkflowMessage
protected java.lang.String breakWorkflowMessageThis message is send to the user who started the workflow if the workflow is canceled. -
userIdsToDeactivate
protected java.lang.String[] userIdsToDeactivateThe list of the person nodes to be deactivated when the workflow is canceled. This option is only used for "parallel for validation" workflow. Otherwise this option is ignored.- Since:
- 9.00.012.004
-
deactivateNodes
protected boolean deactivateNodesIf true, all person nodes are deactivated when the workflow is canceled. This option is only used for "parallel for validation" workflow. Otherwise this option is ignored.- Since:
- 9.00.012.004
-
acceptMessage
protected java.lang.String acceptMessageThis message is shown if the workflow is accepted by a person.- Since:
- 9.00.012.006
-
noticeMessage
protected java.lang.String noticeMessageThis message is shown if the a person was informed about the workflow.- Since:
- 9.00.012.006
-
actionRejectMessage
protected java.lang.String actionRejectMessageThis message is shown if the workflow is rejected.- Since:
- 9.00.014.006
-
successMessage
protected java.lang.String successMessageThis message is shown if the workflow is successfully processed.- Since:
- 9.00.014.006
-
timeLimit
Time-limit for the entire workflow.- Since:
- 9.00.016.009
- See Also:
timeLimitEscalations
-
timeLimitEscalations
Additional definitions for time limits.- Since:
- 9.00.016.009
- See Also:
WFDiagram.timeLimit
,WFDiagram.timeLimitUserId
,WFDiagram.overTimeLimit
-
flags
protected int flagsControl flags for the node, a combination of WFNode.C.FLAG_* constants.- Since:
- 9.00.016.013
-
nodeInfos
The information of all nodes in the workflow.- Since:
- 10.00.000.008
-
-
Constructor Details
-
StartAdHocWorkflowInfo
public StartAdHocWorkflowInfo() -
StartAdHocWorkflowInfo
-
-
Method Details
-
isForValidation
public boolean isForValidation() -
setForValidation
public void setForValidation(boolean forValidation) -
isSerialFlow
public boolean isSerialFlow() -
setSerialFlow
public void setSerialFlow(boolean serialFlow) -
getCancelUserId
public java.lang.String getCancelUserId() -
setCancelUserId
public void setCancelUserId(java.lang.String cancelUserId) -
getCancelMessage
public java.lang.String getCancelMessage() -
setCancelMessage
public void setCancelMessage(java.lang.String cancelMessage) -
getFinishedUserId
public java.lang.String getFinishedUserId() -
setFinishedUserId
public void setFinishedUserId(java.lang.String finishedUserId) -
getFinishedMessage
public java.lang.String getFinishedMessage() -
setFinishedMessage
public void setFinishedMessage(java.lang.String finishedMessage) -
getFinishedScript
public java.lang.String getFinishedScript() -
setFinishedScript
public void setFinishedScript(java.lang.String finishedScript) -
getNodeName
public java.lang.String getNodeName() -
setNodeName
public void setNodeName(java.lang.String nodeName) -
getWorkflowRepeatMessage
public java.lang.String getWorkflowRepeatMessage() -
setWorkflowRepeatMessage
public void setWorkflowRepeatMessage(java.lang.String workflowRepeatMessage) -
getBreakWorkflowMessage
public java.lang.String getBreakWorkflowMessage() -
setBreakWorkflowMessage
public void setBreakWorkflowMessage(java.lang.String breakWorkflowMessage) -
getUserIdsToDeactivate
public java.lang.String[] getUserIdsToDeactivate() -
setUserIdsToDeactivate
public void setUserIdsToDeactivate(java.lang.String[] userIdsToDeactivate) -
isDeactivateNodes
public boolean isDeactivateNodes() -
setDeactivateNodes
public void setDeactivateNodes(boolean deactivateNodes) -
getAcceptMessage
public java.lang.String getAcceptMessage() -
setAcceptMessage
public void setAcceptMessage(java.lang.String acceptMessage) -
getNoticeMessage
public java.lang.String getNoticeMessage() -
setNoticeMessage
public void setNoticeMessage(java.lang.String noticeMessage) -
getActionRejectMessage
public java.lang.String getActionRejectMessage() -
setActionRejectMessage
public void setActionRejectMessage(java.lang.String actionRejectMessage) -
getSuccessMessage
public java.lang.String getSuccessMessage() -
setSuccessMessage
public void setSuccessMessage(java.lang.String successMessage) -
getTimeLimit
-
setTimeLimit
-
getTimeLimitEscalations
-
setTimeLimitEscalations
-
getFlags
public int getFlags() -
setFlags
public void setFlags(int flags) -
getNodeInfos
-
setNodeInfos
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-