Class StopWorkflowAction
java.lang.Object
de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction
de.uplanet.lucy.server.workflow.action.StopWorkflowAction
- All Implemented Interfaces:
IActivatableWorkflowObject
,INamedWorkflowObject
,INeedWorkflow
,IWorkflowAction
,IWorkflowObject
,Serializable
- See Also:
-
Field Summary
Fields inherited from interface de.uplanet.lucy.server.workflow.IWorkflowObject
GUID_COMPARATOR
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
This flag indicates if all branches of the currently executing workflow should be stopped.boolean
This flag indicates if timer controllers should be stopped.process
(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx) Process a workflow event in the given context.void
setEfferentTransition
(WorkflowTransition p_wfTransition) Set the efferent transition of this workflow action.void
setStopAllBranches
(boolean p_bStopAllBranches) This flag indicates if all branches of the currently executing workflow should be stopped.void
setStopTimerController
(boolean p_bStopTimerController) This flag indicates if timer controllers should be stopped.Methods inherited from class de.uplanet.lucy.server.workflow.action.AbstractWorkflowAction
getAfferentTransition, getEfferentTransition, getGuid, getName, getWorkflow, isActive, setActive, setAfferentTransition, setName, setWorkflow, toString
-
Constructor Details
-
StopWorkflowAction
-
-
Method Details
-
setEfferentTransition
Description copied from interface:IWorkflowAction
Set the efferent transition of this workflow action.- Specified by:
setEfferentTransition
in interfaceIWorkflowAction
- Overrides:
setEfferentTransition
in classAbstractWorkflowAction
- Parameters:
p_wfTransition
- The transition to be set.- Throws:
UnsupportedOperationException
- SinceStopWorkflowAction
s cannot have efferent transitions.
-
isStopAllBranches
public boolean isStopAllBranches()This flag indicates if all branches of the currently executing workflow should be stopped.- Returns:
- The flag.
-
setStopAllBranches
public void setStopAllBranches(boolean p_bStopAllBranches) This flag indicates if all branches of the currently executing workflow should be stopped.- Parameters:
p_bStopAllBranches
- The new value for the flag.
-
isStopTimerController
public boolean isStopTimerController()This flag indicates if timer controllers should be stopped.If so, no further records will be fed by the currently executing timer controller.
- Returns:
- The flag.
-
setStopTimerController
public void setStopTimerController(boolean p_bStopTimerController) This flag indicates if timer controllers should be stopped.If so, no further records will be fed by the currently executing timer controller.
- Parameters:
p_bStopTimerController
- The new value for the flag.
-
process
public WorkflowTransition process(IWorkflowEvent p_evt, de.uplanet.lucy.server.workflow.IWorkflowProcessingContext p_wfCtx, de.uplanet.lucy.server.IProcessingContext p_ctx) throws Exception Description copied from interface:IWorkflowAction
Process a workflow event in the given context.Normally, a workflow action should return its efferent transition, regardless whether it is
active
, or not.- Parameters:
p_evt
- The event to be processed.p_wfCtx
- The workflow processing context.p_ctx
- The processing context.- Returns:
- Always
null
. - Throws:
InterruptedException
- If processing of this action has been interrupted.Exception
- If an error occurred.
-