com.aspc.workflow.internal

Interface DBEventActionPlugin

All Known Implementing Classes:

ClearShallowCopyAction, CustomActionPlugin, OnlineRequestOnCreateEventPlugin, SendApprovalEmailPlugin

public interface DBEventActionPlugin

Allows the designer to add custom validation for a DBEvent
THREAD MODE: SINGLE-THREADED

Since:

September 5, 2005

Author:

Jason McGrath

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSummary(DBEvent event, java.lang.String summary) Returns a summary of the validation
void	process(MutableDataSource mds, DBEvent event, DBObject base) Performs the custom action

Method Detail

process

void process(MutableDataSource mds,
             DBEvent event,
             DBObject base)
      throws java.lang.Exception

Performs the custom action

Parameters:

mds - - The MutableDataSource that all actions should be applied to

event - - The event that has been raised

base - - Base object that the event was raised for

Throws:

java.lang.Exception - - A serious error

getSummary

java.lang.String getSummary(DBEvent event,
                            java.lang.String summary)

Returns a summary of the validation

Parameters:

event - - The event that the validation is for

summary - - The system generated sumary

Returns:

String - A short description of the validation