com.ibm.workplace.wcm.api.custom
Interface NextStageDirectiveParams

All Superinterfaces:

DirectiveParams, java.io.Serializable

All Known Implementing Classes:

WCM_NextStageDirectiveParams

public interface NextStageDirectiveParams
extends DirectiveParams

The NextStageDirectiveParams object is used to specify arguments or options to a 'NextStage' Directive.

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

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

Since:

6.1

Method Summary

boolean	isRunningEntryActions() Indicates if the entry actions on the destination stage should be run.
boolean	isRunningExitActions() Indicates if the exit actions on the current stage are run before moving to the next stage.
void	setRunEntryActions(boolean runEntryActions) Specifies whether to run the entry actions on the destination stage.
void	setRunExitActions(boolean runExitActions) Specifies whether to run the exit actions on the current stage before moving to the next stage.

Method Detail

setRunExitActions

void setRunExitActions(boolean runExitActions)

Specifies whether to run the exit actions on the current stage before moving to the next stage.

By default exit actions are run.

Parameters:

runExitActions - true if the exit actions on the current stage should be run before moving to the next stage, false otherwise

isRunningExitActions

boolean isRunningExitActions()

Indicates if the exit actions on the current stage are run before moving to the next stage.

Returns:

true if the exit actions on the current stage are run before moving to the next stage, false otherwise

setRunEntryActions

void setRunEntryActions(boolean runEntryActions)

Specifies whether to run the entry actions on the destination stage.

By default entry actions are run.

Parameters:

runEntryActions - true if the entry actions on the destination stage should be run, false otherwise

isRunningEntryActions

boolean isRunningEntryActions()

Indicates if the entry actions on the destination stage should be run.

Returns:

true if the entry actions on the destination stage should be run, false otherwise