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

java.lang.Object
  com.ibm.workplace.wcm.api.custom.WCM_ContinueDirectiveParams

All Implemented Interfaces:

ContinueDirectiveParams, DirectiveParams, java.io.Serializable

public class WCM_ContinueDirectiveParams
extends java.lang.Object
implements ContinueDirectiveParams

The ContinueDirectiveParams object is used to specify arguments or options to a 'Continue' Directive.

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

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

Note that this directive parameter allows a refetch flag (default: false) to be set to allow the item state to be refreshed in memory in case the persisted item state has changed during the custom action.

If the refetch flag is set, all in-memory changes made during the custom action must be saved by the end of the action, otherwise these changes will be lost after the item refetch. Also if the item is saved during an action, any changes made up to that point will not be available for rollback even if an eventual ROLLBACK directive is returned.

Since:

8.5

See Also:

Serialized Form

Constructor Summary

WCM_ContinueDirectiveParams()

Method Summary

boolean	isRequireRefetch() Indicates if an item refetch has been requested
void	setRequireRefetch(boolean p_requireRefetch) Specifies whether the Continue Directive should perform an item refetch.(default: false)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WCM_ContinueDirectiveParams

public WCM_ContinueDirectiveParams()

Method Detail

setRequireRefetch

public void setRequireRefetch(boolean p_requireRefetch)

Description copied from interface: ContinueDirectiveParams

Specifies whether the Continue Directive should perform an item refetch.(default: false)

This is useful when the persisted item state is changed during an action (e.g. a move) but the in-memory state have not been reflected.

Use with caution, if set, all changes made before and during the custom action must be explicitly saved by the action itself.

Specified by:

setRequireRefetch in interface ContinueDirectiveParams

Parameters:

p_requireRefetch - true if an item refetch should be performed. false otherwise

isRequireRefetch

public boolean isRequireRefetch()

Description copied from interface: ContinueDirectiveParams

Indicates if an item refetch has been requested

Specified by:

isRequireRefetch in interface ContinueDirectiveParams

Returns:

true if an item refetch has been requested, false otherwise