org.kuali.rice.edl.framework.workflow

Class EDocLitePostProcessor

java.lang.Object

org.kuali.rice.kew.postprocessor.DefaultPostProcessor

org.kuali.rice.edl.framework.workflow.EDocLitePostProcessor

All Implemented Interfaces:

PostProcessor

Direct Known Subclasses:

EDocLiteDatabasePostProcessor

public class EDocLitePostProcessor
extends DefaultPostProcessor

PostProcessor responsible for posting events to a url defined in the EDL doc definition.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_TYPE_ACTION_TAKEN
static String	EVENT_TYPE_DELETE_ROUTE_HEADER
static String	EVENT_TYPE_ROUTE_LEVEL_CHANGE
static String	EVENT_TYPE_ROUTE_STATUS_CHANGE
static int	SUBMIT_URL_MILLISECONDS_WAIT

Constructor Summary

Constructors

Constructor and Description
EDocLitePostProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
ProcessDocReport	doActionTaken(ActionTakenEvent event) Executed whenever an action is taken against the document.
ProcessDocReport	doDeleteRouteHeader(DeleteEvent event) Executed whenever a deletion of the document is required.
ProcessDocReport	doRouteLevelChange(DocumentRouteLevelChange event) Executed whenever the document transitions from one node to another.
ProcessDocReport	doRouteStatusChange(DocumentRouteStatusChange event) Executed whenever the status of the document changes.
static DocumentBuilder	getDocumentBuilder()
static Document	getEDLContent(String documentId)
protected static void	postEvent(String docId, Object event, String eventName)
static Element	propertiesToXml(Object o, String elementName)

Methods inherited from class org.kuali.rice.kew.postprocessor.DefaultPostProcessor

afterActionTaken, afterProcess, beforeProcess, getDocumentIdsToLock

Methods inherited from class java.lang.Object

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

Field Detail

SUBMIT_URL_MILLISECONDS_WAIT

public static final int SUBMIT_URL_MILLISECONDS_WAIT

See Also:

Constant Field Values

EVENT_TYPE_ACTION_TAKEN

public static final String EVENT_TYPE_ACTION_TAKEN

See Also:

Constant Field Values

EVENT_TYPE_DELETE_ROUTE_HEADER

public static final String EVENT_TYPE_DELETE_ROUTE_HEADER

See Also:

Constant Field Values

EVENT_TYPE_ROUTE_LEVEL_CHANGE

public static final String EVENT_TYPE_ROUTE_LEVEL_CHANGE

See Also:

Constant Field Values

EVENT_TYPE_ROUTE_STATUS_CHANGE

public static final String EVENT_TYPE_ROUTE_STATUS_CHANGE

See Also:

Constant Field Values

Constructor Detail

EDocLitePostProcessor

public EDocLitePostProcessor()

Method Detail

postEvent

protected static void postEvent(String docId,
             Object event,
             String eventName)

doRouteStatusChange

public ProcessDocReport doRouteStatusChange(DocumentRouteStatusChange event)
                                     throws RemoteException

Description copied from interface: PostProcessor

Executed whenever the status of the document changes.

Specified by:

doRouteStatusChange in interface PostProcessor

Overrides:

doRouteStatusChange in class DefaultPostProcessor

Returns:

ProcessDocReport indicating if the status change succeeded

Throws:

RemoteException

doActionTaken

public ProcessDocReport doActionTaken(ActionTakenEvent event)
                               throws RemoteException

Description copied from interface: PostProcessor

Executed whenever an action is taken against the document.

Specified by:

doActionTaken in interface PostProcessor

Overrides:

doActionTaken in class DefaultPostProcessor

Returns:

ProcessDocReport indicating whether or not the action should succeed

Throws:

RemoteException

doDeleteRouteHeader

public ProcessDocReport doDeleteRouteHeader(DeleteEvent event)
                                     throws RemoteException

Description copied from interface: PostProcessor

Executed whenever a deletion of the document is required.

Specified by:

doDeleteRouteHeader in interface PostProcessor

Overrides:

doDeleteRouteHeader in class DefaultPostProcessor

Returns:

ProcessDocReport indicating if the deletion should be permitted to occur or not

Throws:

RemoteException

doRouteLevelChange

public ProcessDocReport doRouteLevelChange(DocumentRouteLevelChange event)
                                    throws RemoteException

Description copied from interface: PostProcessor

Executed whenever the document transitions from one node to another.

Specified by:

doRouteLevelChange in interface PostProcessor

Overrides:

doRouteLevelChange in class DefaultPostProcessor

Returns:

ProcessDocReport indicating if the node transition succeeded

Throws:

RemoteException

getEDLContent

public static Document getEDLContent(String documentId)

getDocumentBuilder

public static DocumentBuilder getDocumentBuilder()
                                          throws Exception

Throws:

Exception

propertiesToXml

public static Element propertiesToXml(Object o,
                      String elementName)
                               throws Exception

Throws:

Exception