org.kuali.rice.ken.service
Interface NotificationWorkflowDocumentService

All Known Implementing Classes:

NotificationWorkflowDocumentServiceImpl

public interface NotificationWorkflowDocumentService

The NotificationWorkflowDocumentService class is responsible for housing service methods for interacting with KEW.

Author:

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

Method Summary

void	clearAllFyisAndAcknowledgeNotificationWorkflowDocument(String initiatorUserId, NotificationWorkflowDocument workflowDocument, String annotation) This method is responsible for canceling a workflow document; which in turn simulates the "checking-off" of a notification in the notification list by the system through an auto-removal.
String	createAndAdHocRouteNotificationWorkflowDocument(NotificationMessageDelivery messageDelivery, String initiatorUserId, String recipientUserId, String annotation) This service method is responsible for creating a NotificationWorkflowDocument for the given user, which in turn, creates a workflow document in KEW.
NotificationWorkflowDocument	getNotificationWorkflowDocumentByDocumentId(String initiatorUserId, String workflowDocumentId) This service method is responsible for retrieving a NotificationWorkflowDocument from KEW.
void	terminateWorkflowDocument(WorkflowDocument document) This method is responsible for unconditionally terminating a workflow document, after which there should be no pending action requests against this document.

Method Detail

createAndAdHocRouteNotificationWorkflowDocument

String createAndAdHocRouteNotificationWorkflowDocument(NotificationMessageDelivery messageDelivery,
                                                       String initiatorUserId,
                                                       String recipientUserId,
                                                       String annotation)
                                                       throws WorkflowException

This service method is responsible for creating a NotificationWorkflowDocument for the given user, which in turn, creates a workflow document in KEW. It then ad-hoc routes the document to the passed in recipient. This method will be used by the NotificationService.deliverNotification() service method.

Parameters:

messageDelivery - - the specific NotificationMessageDelivery that is associated with this ad hoc route

initiatorUserId - - the person/workflow user who is responsible for "initiating" this workflow document

recipientUserId - - the person/workflow user who will recieve this document via an ad hoc route

annotation - - a description of the workflow ad hoc route transaction

Returns:

String - the id of the workflow document

Throws:

WorkflowException

clearAllFyisAndAcknowledgeNotificationWorkflowDocument

void clearAllFyisAndAcknowledgeNotificationWorkflowDocument(String initiatorUserId,
                                                            NotificationWorkflowDocument workflowDocument,
                                                            String annotation)
                                                            throws WorkflowException

This method is responsible for canceling a workflow document; which in turn simulates the "checking-off" of a notification in the notification list by the system through an auto-removal.

Parameters:

initiatorUserId -

workflowDocument -

annotation -

Throws:

WorkflowException

terminateWorkflowDocument

void terminateWorkflowDocument(WorkflowDocument document)
                               throws WorkflowException

This method is responsible for unconditionally terminating a workflow document, after which there should be no pending action requests against this document.

Parameters:

document - workflow document to terminate

Throws:

WorkflowException

getNotificationWorkflowDocumentByDocumentId

NotificationWorkflowDocument getNotificationWorkflowDocumentByDocumentId(String initiatorUserId,
                                                                         String workflowDocumentId)
                                                                         throws WorkflowException

This service method is responsible for retrieving a NotificationWorkflowDocument from KEW.

Parameters:

initiatorUserId -

workflowDocumentId -

Returns:

NotificationWorkflowDocument

Throws:

WorkflowException