com.ibm.workplace.wcm.api.custom
Class WCM_PreviousStageDirectiveParams

java.lang.Object
  extended by com.ibm.workplace.wcm.api.custom.WCM_PreviousStageDirectiveParams
All Implemented Interfaces:
DirectiveParams, PreviousStageDirectiveParams, java.io.Serializable

public class WCM_PreviousStageDirectiveParams
extends java.lang.Object
implements PreviousStageDirectiveParams

The PreviousStageDirectiveParams object is used to specify arguments or options to a 'PreviousStage' Directive.

To create a new PreviousStageDirectiveParams object call Directives.PREVIOUS_WORKFLOW_STAGE.createDirectiveParams() and cast the returned object to PreviousStageDirectiveParams

To use a PreviousStageDirectiveParams object call the CustomWorkflowActionService.createResult(Directive, String, DirectiveParams) method instead of CustomWorkflowActionService.createResult(Directive, String) to construct the workflow action result.

Since:
6.1
See Also:
Serialized Form

Constructor Summary
WCM_PreviousStageDirectiveParams()
           
 
Method Summary
 boolean isRunningEntryActions()
          Indicates if the entry actions on the destination stage should be run.
 void setRunEntryActions(boolean runEntryActions)
          Specifies whether to run the entry actions on the destination stage.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WCM_PreviousStageDirectiveParams

public WCM_PreviousStageDirectiveParams()
Method Detail

setRunEntryActions

public void setRunEntryActions(boolean runEntryActions)
Specifies whether to run the entry actions on the destination stage.

By default entry actions are run.

Specified by:
setRunEntryActions in interface PreviousStageDirectiveParams
Parameters:
runEntryActions - true if the entry actions on the destination stage should be run, false otherwise

isRunningEntryActions

public boolean isRunningEntryActions()
Indicates if the entry actions on the destination stage should be run.

Specified by:
isRunningEntryActions in interface PreviousStageDirectiveParams
Returns:
true if the entry actions on the destination stage should be run, false otherwise