org.kuali.rice.ken.document.kew

Class NotificationWorkflowDocument

java.lang.Object

org.kuali.rice.ken.document.kew.NotificationWorkflowDocument

public final class NotificationWorkflowDocument
extends Object

This class extends the KEW WorkflowDocument object and becomes our gateway for get a handle on KEW documents in workflow.

Author:

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

Method Summary

Modifier and Type	Method and Description
static WorkflowDocument	createNotificationDocument(String principalId) Constructs a NotificationWorkflowDocument instance - this essentially creates a new routable document in KEW for the given user.
static WorkflowDocument	createNotificationDocument(String principalId, String documentTypeName) Constructs a NotificationWorkflowDocument instance - this essentially creates a new routable document in KEW for the given user and document type name.
static WorkflowDocument	loadNotificationDocument(String principalId, String documentId) Constructs a NotificationWorkflowDocument instance - this one is used to get a handle on a workflow document that was already created in the system.

Methods inherited from class java.lang.Object

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

Method Detail

createNotificationDocument

public static WorkflowDocument createNotificationDocument(String principalId)

Constructs a NotificationWorkflowDocument instance - this essentially creates a new routable document in KEW for the given user.

Parameters:

principalId -

Throws:

WorkflowException

createNotificationDocument

public static WorkflowDocument createNotificationDocument(String principalId,
                                                          String documentTypeName)

Constructs a NotificationWorkflowDocument instance - this essentially creates a new routable document in KEW for the given user and document type name.

Parameters:

user -

documentTypeName -

Throws:

WorkflowException

loadNotificationDocument

public static WorkflowDocument loadNotificationDocument(String principalId,
                                                        String documentId)

Constructs a NotificationWorkflowDocument instance - this one is used to get a handle on a workflow document that was already created in the system.

Parameters:

user -

documentId -

Throws:

WorkflowException