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.StringacceptMessageThis message is shown if the workflow is accepted by a person.protected java.lang.StringactionRejectMessageThis message is shown if the workflow is rejected.protected java.lang.StringbreakWorkflowMessageThis message is send to the user who started the workflow if the workflow is canceled.protected java.lang.StringcancelMessageThe message that is send to the user specified withcancelUserId, if the workflow is canceled.protected java.lang.StringcancelUserIdIf the workflow is canceled, this user receives a message,cancelMessage.protected booleandeactivateNodesIf true, all person nodes are deactivated when the workflow is canceled.protected java.lang.StringfinishedMessageThe message that is send to the user specified withfinishedUserId, if the workflow is finished.protected java.lang.StringfinishedScriptThis script is executed, when the workflow is finished.protected java.lang.StringfinishedUserIdIf the workflow is finished, this user receives a message,finishedMessage.protected intflagsControl flags for the node, a combination of WFNode.C.FLAG_* constants.protected booleanforValidationIf true, the workflow comes back to the user who started it.protected java.util.List<ValueClass>nodeInfosThe information of all nodes in the workflow.protected java.lang.StringnodeNameStart node name.protected java.lang.StringnoticeMessageThis message is shown if the a person was informed about the workflow.protected booleanserialFlowIf true, the workflow routes the object from user to user.protected java.lang.StringsuccessMessageThis message is shown if the workflow is successfully processed.protected WFTimeLimittimeLimitTime-limit for the entire workflow.protected WFTimeLimit[]timeLimitEscalationsAdditional definitions for time limits.protected java.lang.String[]userIdsToDeactivateThe list of the person nodes to be deactivated when the workflow is canceled.protected java.lang.StringworkflowRepeatMessageThis 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.StringgetAcceptMessage()java.lang.StringgetActionRejectMessage()java.lang.StringgetBreakWorkflowMessage()java.lang.StringgetCancelMessage()java.lang.StringgetCancelUserId()java.lang.StringgetFinishedMessage()java.lang.StringgetFinishedScript()java.lang.StringgetFinishedUserId()intgetFlags()java.util.List<ValueClass>getNodeInfos()java.lang.StringgetNodeName()java.lang.StringgetNoticeMessage()java.lang.StringgetSuccessMessage()WFTimeLimitgetTimeLimit()WFTimeLimit[]getTimeLimitEscalations()java.lang.String[]getUserIdsToDeactivate()java.lang.StringgetWorkflowRepeatMessage()booleanisDeactivateNodes()booleanisForValidation()booleanisSerialFlow()voidsetAcceptMessage(java.lang.String acceptMessage)voidsetActionRejectMessage(java.lang.String actionRejectMessage)voidsetBreakWorkflowMessage(java.lang.String breakWorkflowMessage)voidsetCancelMessage(java.lang.String cancelMessage)voidsetCancelUserId(java.lang.String cancelUserId)voidsetDeactivateNodes(boolean deactivateNodes)voidsetFinishedMessage(java.lang.String finishedMessage)voidsetFinishedScript(java.lang.String finishedScript)voidsetFinishedUserId(java.lang.String finishedUserId)voidsetFlags(int flags)voidsetForValidation(boolean forValidation)voidsetNodeInfos(java.util.List<ValueClass> nodeInfos)voidsetNodeName(java.lang.String nodeName)voidsetNoticeMessage(java.lang.String noticeMessage)voidsetSerialFlow(boolean serialFlow)voidsetSuccessMessage(java.lang.String successMessage)voidsetTimeLimit(WFTimeLimit timeLimit)voidsetTimeLimitEscalations(WFTimeLimit[] timeLimitEscalation)voidsetUserIdsToDeactivate(java.lang.String[] userIdsToDeactivate)voidsetWorkflowRepeatMessage(java.lang.String workflowRepeatMessage)java.lang.StringtoString()
-
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. IfserialFlowis 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:
toStringin classjava.lang.Object
-