com.centurylink.mdw.services

Interface EventServices

All Known Implementing Classes:

EventServicesImpl

public interface EventServices

Method Summary

Modifier and Type	Method and Description
void	cancelProcess(java.lang.Long processInstanceId)
void	createAuditLog(UserAction userAction)
java.lang.Long	createDocument(java.lang.String variableType, java.lang.String ownerType, java.lang.Long ownerId, java.lang.Object docObj, Package pkg)
java.lang.Long	createDocument(java.lang.String variableType, java.lang.String ownerType, java.lang.Long ownerId, java.lang.Object docObj, Package pkg, java.lang.String path)
java.lang.Long	createEventLog(java.lang.String eventName, java.lang.String category, java.lang.String subcategory, java.lang.String source, java.lang.String ownerType, java.lang.Long ownerId, java.lang.String user, java.lang.String modUser, java.lang.String comments)
void	deleteEventInstance(java.lang.String eventName)
void	deleteEventWaitInstance(java.lang.String eventName)
Process	findProcessByProcessInstanceId(java.lang.Long processInstanceId)
ActivityInstance	getActivityInstance(java.lang.Long pActivityInstId) Returns the ActivityInstance identified by the passed in Id
java.util.List<ActivityInstance>	getActivityInstances(java.lang.String masterRequestId, java.lang.String processName, java.lang.String activityLogicalId) Returns the activity instances by process name, activity logical ID, and master request ID.
EventInstance	getEventInstance(java.lang.String eventName)
java.util.List<EventLog>	getEventLogs(java.lang.String eventName, java.lang.String source, java.lang.String ownerType, java.lang.Long ownerId)
ProcessInstance	getProcessInstance(java.lang.Long procInstId) Returns the Process instance object identified by the passed in Id
java.util.List<ProcessInstance>	getProcessInstances(java.lang.String masterRequestId, java.lang.String processName) Returns the process instances by process name and master request ID.
ServiceHandler	getServiceHandler(java.lang.String protocol, java.lang.String path)
VariableInstance	getVariableInstance(java.lang.Long varInstId) get variable instance by its ID
VariableInstance	getVariableInstance(java.lang.Long procInstId, java.lang.String name) Get variable instance for a process instance.
WorkflowHandler	getWorkflowHandler(java.lang.String asset, java.util.Map<java.lang.String,java.lang.String> parameters)
TransitionInstance	getWorkTransitionInstance(java.lang.Long transInstId) Returns the transition instance object by ID
java.lang.Integer	notifyProcess(java.lang.String eventName, java.lang.Long eventInstanceId, java.lang.String message, int delay)
void	registerServiceHandler(ServiceHandler handler) Register a service handler to respond to MDW listener requests.
void	registerWorkflowHandler(WorkflowHandler handler) Register a workflow handler to respond to activity triggers.
void	retryActivity(java.lang.Long activityId, java.lang.Long activityInstId)
void	sendDelayEventsToWaitActivities(java.lang.String masterRequestId)
VariableInstance	setVariableInstance(java.lang.Long procInstId, java.lang.String name, java.lang.Object value, Package pkg) Set the variable instance value.
void	skipActivity(java.lang.Long activityId, java.lang.Long activityInstId, java.lang.String completionCode) Skip the activity by sending an activity finish event, with the given completion code.
void	unregisterServiceHandler(ServiceHandler handler)
void	unregisterWorkflowHandler(WorkflowHandler handler)
void	updateDocumentContent(java.lang.Long docid, java.lang.Object docObj, Package pkg)
void	updateDocumentInfo(java.lang.Long docid, java.lang.String documentType, java.lang.String ownerType, java.lang.Long ownerId)
void	updateEventInstance(java.lang.String eventName, java.lang.Long documentId, java.lang.Integer status, java.util.Date consumeDate, java.lang.String auxdata, java.lang.String reference, int preserveSeconds)
void	updateEventInstance(java.lang.String eventName, java.lang.Long documentId, java.lang.Integer status, java.util.Date consumeDate, java.lang.String auxdata, java.lang.String reference, int preserveSeconds, java.lang.String comments)

Method Detail

createAuditLog

void createAuditLog(UserAction userAction)
             throws DataAccessException,
                    EventException

Throws:

DataAccessException

EventException

createEventLog

java.lang.Long createEventLog(java.lang.String eventName,
                              java.lang.String category,
                              java.lang.String subcategory,
                              java.lang.String source,
                              java.lang.String ownerType,
                              java.lang.Long ownerId,
                              java.lang.String user,
                              java.lang.String modUser,
                              java.lang.String comments)
                       throws DataAccessException,
                              EventException

Throws:

DataAccessException

EventException

getEventLogs

java.util.List<EventLog> getEventLogs(java.lang.String eventName,
                                      java.lang.String source,
                                      java.lang.String ownerType,
                                      java.lang.Long ownerId)
                               throws ServiceException

Throws:

ServiceException

notifyProcess

java.lang.Integer notifyProcess(java.lang.String eventName,
                                java.lang.Long eventInstanceId,
                                java.lang.String message,
                                int delay)
                         throws DataAccessException,
                                EventException

Throws:

DataAccessException

EventException

getVariableInstance

VariableInstance getVariableInstance(java.lang.Long varInstId)
                              throws DataAccessException

get variable instance by its ID

Throws:

DataAccessException

getVariableInstance

VariableInstance getVariableInstance(java.lang.Long procInstId,
                                     java.lang.String name)
                              throws DataAccessException

Get variable instance for a process instance. The method does not take care of embedded process, so the caller needs to pass the parent process instance id when looking for variables for embedded process

Throws:

DataAccessException

setVariableInstance

VariableInstance setVariableInstance(java.lang.Long procInstId,
                                     java.lang.String name,
                                     java.lang.Object value,
                                     Package pkg)
                              throws DataAccessException

Set the variable instance value. The method does not take care of document variables, for which you must pass in DocumentReferenceObject. The method does not take care of embedded process, so the caller needs to pass the parent process instance id when looking for variables for embedded process

Throws:

DataAccessException

updateDocumentContent

void updateDocumentContent(java.lang.Long docid,
                           java.lang.Object docObj,
                           Package pkg)
                    throws DataAccessException

Throws:

DataAccessException

updateDocumentInfo

void updateDocumentInfo(java.lang.Long docid,
                        java.lang.String documentType,
                        java.lang.String ownerType,
                        java.lang.Long ownerId)
                 throws DataAccessException

Throws:

DataAccessException

createDocument

java.lang.Long createDocument(java.lang.String variableType,
                              java.lang.String ownerType,
                              java.lang.Long ownerId,
                              java.lang.Object docObj,
                              Package pkg)
                       throws DataAccessException

Throws:

DataAccessException

createDocument

java.lang.Long createDocument(java.lang.String variableType,
                              java.lang.String ownerType,
                              java.lang.Long ownerId,
                              java.lang.Object docObj,
                              Package pkg,
                              java.lang.String path)
                       throws DataAccessException

Throws:

DataAccessException

sendDelayEventsToWaitActivities

void sendDelayEventsToWaitActivities(java.lang.String masterRequestId)
                              throws DataAccessException,
                                     ProcessException

Throws:

DataAccessException

ProcessException

cancelProcess

void cancelProcess(java.lang.Long processInstanceId)
            throws DataAccessException,
                   ServiceException

Throws:

DataAccessException

ServiceException

retryActivity

void retryActivity(java.lang.Long activityId,
                   java.lang.Long activityInstId)
            throws DataAccessException,
                   ProcessException

Throws:

DataAccessException

ProcessException

skipActivity

void skipActivity(java.lang.Long activityId,
                  java.lang.Long activityInstId,
                  java.lang.String completionCode)
           throws DataAccessException,
                  ProcessException

Skip the activity by sending an activity finish event, with the given completion code. The status of the activity instance is ???

Throws:

DataAccessException

ProcessException

getWorkTransitionInstance

TransitionInstance getWorkTransitionInstance(java.lang.Long transInstId)
                                      throws DataAccessException,
                                             ProcessException

Returns the transition instance object by ID

Returns:

transition instance object

Throws:

DataAccessException

ProcessException

getActivityInstance

ActivityInstance getActivityInstance(java.lang.Long pActivityInstId)
                              throws ProcessException,
                                     DataAccessException

Returns the ActivityInstance identified by the passed in Id

Throws:

ProcessException

DataAccessException

getActivityInstances

java.util.List<ActivityInstance> getActivityInstances(java.lang.String masterRequestId,
                                                      java.lang.String processName,
                                                      java.lang.String activityLogicalId)
                                               throws ProcessException,
                                                      DataAccessException

Returns the activity instances by process name, activity logical ID, and master request ID.

Returns:

the list of activity instances. If the process definition or the activity with the given logical ID is not found, null or no such activity instances are found, an empty list is returned.

Throws:

ProcessException

DataAccessException

getProcessInstance

ProcessInstance getProcessInstance(java.lang.Long procInstId)
                            throws ProcessException,
                                   DataAccessException

Returns the Process instance object identified by the passed in Id

Throws:

ProcessException

DataAccessException

getProcessInstances

java.util.List<ProcessInstance> getProcessInstances(java.lang.String masterRequestId,
                                                    java.lang.String processName)
                                             throws ProcessException,
                                                    DataAccessException

Returns the process instances by process name and master request ID.

Returns:

the list of process instances. If the process definition is not found, null is returned; if process definition is found but no process instances are found, an empty list is returned.

Throws:

ProcessException

DataAccessException

updateEventInstance

void updateEventInstance(java.lang.String eventName,
                         java.lang.Long documentId,
                         java.lang.Integer status,
                         java.util.Date consumeDate,
                         java.lang.String auxdata,
                         java.lang.String reference,
                         int preserveSeconds)
                  throws DataAccessException

Throws:

DataAccessException

updateEventInstance

void updateEventInstance(java.lang.String eventName,
                         java.lang.Long documentId,
                         java.lang.Integer status,
                         java.util.Date consumeDate,
                         java.lang.String auxdata,
                         java.lang.String reference,
                         int preserveSeconds,
                         java.lang.String comments)
                  throws DataAccessException

Throws:

DataAccessException

deleteEventInstance

void deleteEventInstance(java.lang.String eventName)
                  throws DataAccessException

Throws:

DataAccessException

deleteEventWaitInstance

void deleteEventWaitInstance(java.lang.String eventName)
                      throws DataAccessException

Throws:

DataAccessException

getEventInstance

EventInstance getEventInstance(java.lang.String eventName)
                        throws DataAccessException

Throws:

DataAccessException

registerServiceHandler

void registerServiceHandler(ServiceHandler handler)
                     throws EventException

Register a service handler to respond to MDW listener requests. The handlers's getProtocol() and getPath() methods are used to uniquely identify the types of requests that it responds to.

Throws:

EventException

unregisterServiceHandler

void unregisterServiceHandler(ServiceHandler handler)
                       throws EventException

Throws:

EventException

getServiceHandler

ServiceHandler getServiceHandler(java.lang.String protocol,
                                 java.lang.String path)
                          throws EventException

Throws:

EventException

registerWorkflowHandler

void registerWorkflowHandler(WorkflowHandler handler)
                      throws EventException

Register a workflow handler to respond to activity triggers. The handlers's getAsset() and getParameters() methods are used to uniquely identify the types of flows the handler responds to. Note: asset should include the workflow package (eg: MyPackage/MyCamelRoute.xml).

Throws:

EventException

unregisterWorkflowHandler

void unregisterWorkflowHandler(WorkflowHandler handler)
                        throws EventException

Throws:

EventException

getWorkflowHandler

WorkflowHandler getWorkflowHandler(java.lang.String asset,
                                   java.util.Map<java.lang.String,java.lang.String> parameters)
                            throws EventException

Throws:

EventException

findProcessByProcessInstanceId

Process findProcessByProcessInstanceId(java.lang.Long processInstanceId)
                                throws DataAccessException,
                                       ProcessException,
                                       java.io.IOException

Throws:

DataAccessException

ProcessException

java.io.IOException