com.ibm.workplace.wcm.api.custom
Interface Directive
- All Superinterfaces:
- java.io.Serializable
-
public interface Directive
- extends java.io.Serializable
A directive is returned within a CustomWorkflowActionResult. It allows custom code to request an
action to be performed against the target Document that are not permitted within
the execute(Document) method or to influence the processing of the current workflow
stage.
- Since:
- 6.1
- See Also:
- Use the Directives interface to obtain an instance of a Directive.,
CustomWorkflowActionResult
createDirectiveParams
DirectiveParams createDirectiveParams()
- Returns a new instance of a DirectiveParams object for the current Directive
The DirectiveParams object should be cast to the appropriate DirectiveParams object
for the given Directive type
- Returns:
- a new instance of a DirectiveParams object for the current Directive OR an
EmptyDirectiveParams object if the current Directive type does not have
an associated DirectiveParams object