lumis.content.workflow
Interface IWorkflowActionHandler

All Known Implementing Classes:

WorkflowSendMailActionHandler

@StableMinor(version="5.5",
             sinceVersion="4.2")
public interface IWorkflowActionHandler

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

Since:

4.0.4

Method Summary

void	preProcessAction(SessionConfig sessionConfig, ContentLocale contentLocale, 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,
                      ContentLocale contentLocale,
                      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.

ContentLocale - the content locale-specific object where the action was performed.

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 canceled.

Since:

4.2.0