lumis.content.workflow
Interface IWorkflowActionHandler

All Known Implementing Classes:

WorkflowSendMailActionHandler

@StableMinor(version="4.1",
             sinceVersion="4.0")
public interface IWorkflowActionHandler

Defines the methods by which a workflow action handler is called.

Since:

4.0.4

Method Summary

void

preProcessAction(SessionConfig sessionConfig, String itemId, String serviceInstanceId, String sourceId, WorkflowTransitionConfig transition, ContentWorkflowMetaData newWorkflowMetaData, ITransaction transaction) Method called when a workflow action is performed, before its changes are applied to the persistence layer.

Method Detail

preProcessAction

void preProcessAction(SessionConfig sessionConfig,
                      String itemId,
                      String serviceInstanceId,
                      String sourceId,
                      WorkflowTransitionConfig transition,
                      ContentWorkflowMetaData newWorkflowMetaData,
                      ITransaction transaction)
                      throws PortalException

Method called when a workflow action is performed, before its changes are applied to the persistence layer.

Parameters:

sessionConfig - the user session information.

itemId - the content item id.

serviceInstanceId - the content service instance id.

sourceId - the content source id.

transition - the transition being performed, or null if no transition is being performed.

newWorkflowMetaData - the new workflow metadata that will be saved. Changes to this object will reflect in the workflow meta data that will be saved.

transaction - the transaction for persistence access.

Throws:

PortalException - if the action should be cancelled.

Since:

4.0.4