org.kuali.rice.ken.service.impl

Class NotificationWorkflowDocumentServiceImpl

java.lang.Object

org.kuali.rice.ken.service.impl.NotificationWorkflowDocumentServiceImpl

All Implemented Interfaces:

NotificationWorkflowDocumentService

public class NotificationWorkflowDocumentServiceImpl
extends Object
implements NotificationWorkflowDocumentService

This class is responsible for interacting with KEW - this is the default implementation that leverages the KEW client API.

Author:

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

Constructor Summary

Constructors

Constructor and Description
NotificationWorkflowDocumentServiceImpl(NotificationMessageContentService messageContentService) Constructs a NotificationWorkflowDocumentServiceImpl instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAllFyisAndAcknowledgeNotificationWorkflowDocument(String initiatorUserId, WorkflowDocument 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) Implements by instantiating a NotificationWorkflowDocument, which in turn interacts with Workflow to set it up with an initiator of the passed in user id.
WorkflowDocument	getNotificationWorkflowDocumentByDocumentId(String initiatorUserId, String workflowDocumentId) This service method is implemented by constructing a NotificationWorkflowDocument using the pre-existing document Id that is passed in.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationWorkflowDocumentServiceImpl

public NotificationWorkflowDocumentServiceImpl(NotificationMessageContentService messageContentService)

Constructs a NotificationWorkflowDocumentServiceImpl instance.

Parameters:

messageContentService -

Method Detail

createAndAdHocRouteNotificationWorkflowDocument

public String createAndAdHocRouteNotificationWorkflowDocument(NotificationMessageDelivery messageDelivery,
                                                     String initiatorUserId,
                                                     String recipientUserId,
                                                     String annotation)

Implements by instantiating a NotificationWorkflowDocument, which in turn interacts with Workflow to set it up with an initiator of the passed in user id.

Specified by:

createAndAdHocRouteNotificationWorkflowDocument in interface NotificationWorkflowDocumentService

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

See Also:

NotificationWorkflowDocumentService.createAndAdHocRouteNotificationWorkflowDocument(org.kuali.rice.ken.bo.NotificationMessageDelivery, java.lang.String, java.lang.String, java.lang.String)

getNotificationWorkflowDocumentByDocumentId

public WorkflowDocument getNotificationWorkflowDocumentByDocumentId(String initiatorUserId,
                                                           String workflowDocumentId)

This service method is implemented by constructing a NotificationWorkflowDocument using the pre-existing document Id that is passed in.

Specified by:

getNotificationWorkflowDocumentByDocumentId in interface NotificationWorkflowDocumentService

Returns:

NotificationWorkflowDocument

See Also:

org.kuali.rice.ken.service.NotificationWorkflowDocumentService#findNotificationWorkflowDocumentByDocumentId(java.lang.String, java.lang.String)

clearAllFyisAndAcknowledgeNotificationWorkflowDocument

public void clearAllFyisAndAcknowledgeNotificationWorkflowDocument(String initiatorUserId,
                                                          WorkflowDocument workflowDocument,
                                                          String annotation)

Description copied from interface: NotificationWorkflowDocumentService

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.

Specified by:

clearAllFyisAndAcknowledgeNotificationWorkflowDocument in interface NotificationWorkflowDocumentService

See Also:

org.kuali.rice.ken.service.NotificationWorkflowDocumentService#clearAllFyisAndAcknowledgeNotificationWorkflowDocument(java.lang.String, org.kuali.rice.ken.document.kew.NotificationWorkflowDocument, java.lang.String)

terminateWorkflowDocument

public void terminateWorkflowDocument(WorkflowDocument document)

Description copied from interface: NotificationWorkflowDocumentService

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

Specified by:

terminateWorkflowDocument in interface NotificationWorkflowDocumentService

Parameters:

document - workflow document to terminate

See Also:

NotificationWorkflowDocumentService.terminateWorkflowDocument(org.kuali.rice.kew.api.WorkflowDocument)