Uses of Interface
org.kuali.rice.kew.api.WorkflowDocument

Packages that use WorkflowDocument

Package	Description
edu.sampleu.travel.web.form
org.kuali.rice.edl.impl.components
org.kuali.rice.ken.deliverer.impl
org.kuali.rice.ken.document.kew
org.kuali.rice.ken.service
org.kuali.rice.ken.service.impl
org.kuali.rice.ken.web.spring
org.kuali.rice.kew.api	Copyright 2005-2014 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
org.kuali.rice.kew.impl.document
org.kuali.rice.kew.web
org.kuali.rice.kns.service	Copyright 2005-2014 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
org.kuali.rice.kns.service.impl
org.kuali.rice.kns.web.struts.form	Copyright 2005-2014 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
org.kuali.rice.krad
org.kuali.rice.krad.bo
org.kuali.rice.krad.service
org.kuali.rice.krad.service.impl
org.kuali.rice.krad.web.form
org.kuali.rice.krad.workflow.service
org.kuali.rice.krad.workflow.service.impl

Uses of WorkflowDocument in edu.sampleu.travel.web.form

Methods in edu.sampleu.travel.web.form with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	TravelDocumentForm2.populateHeaderFields(WorkflowDocument workflowDocument)

Uses of WorkflowDocument in org.kuali.rice.edl.impl.components

Methods in org.kuali.rice.edl.impl.components with parameters of type WorkflowDocument

Modifier and Type	Method and Description
static List<String>	WorkflowDocumentState.determineValidActions(WorkflowDocument wfdoc)
static void	WorkflowDocumentActions.takeAction(WorkflowDocument document, Document dom, EDLContext edlContext)

Uses of WorkflowDocument in org.kuali.rice.ken.deliverer.impl

Methods in org.kuali.rice.ken.deliverer.impl with parameters of type WorkflowDocument

Modifier and Type	Method and Description
protected void	KEWActionListMessageDeliverer.flagWorkflowDocument(WorkflowDocument doc) Marks the workflow document as originating from the Notification System, so that the Notification post-processor does not route the action back through the Notification System.

Uses of WorkflowDocument in org.kuali.rice.ken.document.kew

Methods in org.kuali.rice.ken.document.kew that return WorkflowDocument

Modifier and Type	Method and Description
static WorkflowDocument	NotificationWorkflowDocument.createNotificationDocument(String principalId) Constructs a NotificationWorkflowDocument instance - this essentially creates a new routable document in KEW for the given user.
static WorkflowDocument	NotificationWorkflowDocument.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	NotificationWorkflowDocument.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.

Uses of WorkflowDocument in org.kuali.rice.ken.service

Methods in org.kuali.rice.ken.service that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	NotificationWorkflowDocumentService.getNotificationWorkflowDocumentByDocumentId(String initiatorUserId, String workflowDocumentId) This service method is responsible for retrieving a NotificationWorkflowDocument from KEW.

Methods in org.kuali.rice.ken.service with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	NotificationWorkflowDocumentService.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.
void	NotificationWorkflowDocumentService.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.

Uses of WorkflowDocument in org.kuali.rice.ken.service.impl

Methods in org.kuali.rice.ken.service.impl that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	NotificationWorkflowDocumentServiceImpl.getNotificationWorkflowDocumentByDocumentId(String initiatorUserId, String workflowDocumentId) This service method is implemented by constructing a NotificationWorkflowDocument using the pre-existing document Id that is passed in.

Methods in org.kuali.rice.ken.service.impl with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	NotificationWorkflowDocumentServiceImpl.clearAllFyisAndAcknowledgeNotificationWorkflowDocument(String initiatorUserId, WorkflowDocument workflowDocument, String annotation)
void	NotificationWorkflowDocumentServiceImpl.terminateWorkflowDocument(WorkflowDocument document)

Uses of WorkflowDocument in org.kuali.rice.ken.web.spring

Methods in org.kuali.rice.ken.web.spring that return WorkflowDocument

Modifier and Type	Method and Description
protected WorkflowDocument	BaseSendNotificationController.createNotificationWorkflowDocument(javax.servlet.http.HttpServletRequest request, String initiatorId, Map<String,Object> model) Creates a notification WorkflowDocument.
WorkflowDocument	AdministerNotificationRequestController.AdministerNotificationRequestCommand.getDocument()

Methods in org.kuali.rice.ken.web.spring with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	AdministerNotificationRequestController.AdministerNotificationRequestCommand.setDocument(WorkflowDocument document)

Uses of WorkflowDocument in org.kuali.rice.kew.api

Methods in org.kuali.rice.kew.api that return WorkflowDocument

Modifier and Type	Method and Description
static WorkflowDocument	WorkflowDocumentFactory.createDocument(String principalId, String documentTypeName) Creates a new workflow document of the given type with the given initiator.
static WorkflowDocument	WorkflowDocumentFactory.createDocument(String principalId, String documentTypeName, DocumentUpdate documentUpdate, DocumentContentUpdate documentContentUpdate) Creates a new workflow document of the given type with the given initiator.
static WorkflowDocument	WorkflowDocumentFactory.createDocument(String principalId, String documentTypeName, String title) Creates a new workflow document of the given type with the given initiator.
static WorkflowDocument	WorkflowDocumentFactory.loadDocument(String principalId, String documentId) Loads an existing workflow document.

Uses of WorkflowDocument in org.kuali.rice.kew.impl.document

Subinterfaces of WorkflowDocument in org.kuali.rice.kew.impl.document

Modifier and Type	Interface and Description
interface	WorkflowDocumentPrototype An implementation/framework interface that extends WorkflowDocument with an initialization method used internally for construction.

Classes in org.kuali.rice.kew.impl.document that implement WorkflowDocument

Modifier and Type	Class and Description
class	WorkflowDocumentImpl The implementation of WorkflowDocument.

Methods in org.kuali.rice.kew.impl.document that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	DefaultWorkflowDocumentProvider.createDocument(String principalId, String documentTypeName, DocumentUpdate documentUpdate, DocumentContentUpdate documentContentUpdate)
WorkflowDocument	WorkflowDocumentProvider.createDocument(String principalId, String documentTypeName, DocumentUpdate documentUpdate, DocumentContentUpdate documentContentUpdate) Creates a new workflow document of the given type with the given initiator.
WorkflowDocument	DefaultWorkflowDocumentProvider.loadDocument(String principalId, String documentId)
WorkflowDocument	WorkflowDocumentProvider.loadDocument(String principalId, String documentId) Loads an existing workflow document.

Uses of WorkflowDocument in org.kuali.rice.kew.web

Methods in org.kuali.rice.kew.web that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	KewRoutingKualiForm.getWorkflowDocument()

Methods in org.kuali.rice.kew.web with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	KewRoutingKualiForm.setWorkflowDocument(WorkflowDocument workflowDocument)

Uses of WorkflowDocument in org.kuali.rice.kns.service

Methods in org.kuali.rice.kns.service that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	SessionDocumentService.getDocumentFromSession(UserSession userSession, String docId) Deprecated. Retrieves a document from the user session for the given document id

Methods in org.kuali.rice.kns.service with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	SessionDocumentService.addDocumentToUserSession(UserSession userSession, WorkflowDocument document) Deprecated. This method places a document into the user session.

Uses of WorkflowDocument in org.kuali.rice.kns.service.impl

Methods in org.kuali.rice.kns.service.impl that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	NoOpSessionDocumentServiceImpl.getDocumentFromSession(UserSession userSession, String docId) Deprecated.

Methods in org.kuali.rice.kns.service.impl with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	NoOpSessionDocumentServiceImpl.addDocumentToUserSession(UserSession userSession, WorkflowDocument document) Deprecated.

Uses of WorkflowDocument in org.kuali.rice.kns.web.struts.form

Methods in org.kuali.rice.kns.web.struts.form that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	KualiDocumentFormBase.getWorkflowDocument() Deprecated.

Methods in org.kuali.rice.kns.web.struts.form with parameters of type WorkflowDocument

Modifier and Type	Method and Description
protected List<HeaderField>	KualiDocumentFormBase.getStandardHeaderFields(WorkflowDocument workflowDocument) Deprecated. This method returns a list of HeaderField objects that are used by default on Kuali document display pages.
void	KualiDocumentFormBase.populateHeaderFields(WorkflowDocument workflowDocument) Deprecated. This method is used to populate the list of header field objects (see KualiForm.getDocInfo()) displayed on the Kuali document form display pages.

Uses of WorkflowDocument in org.kuali.rice.krad

Methods in org.kuali.rice.krad that return WorkflowDocument

Modifier and Type	Method and Description
static WorkflowDocument	UserSessionUtils.getWorkflowDocument(UserSession userSession, String workflowDocumentId) Returns the WorkflowDocument with the given ID from the UserSession.

Methods in org.kuali.rice.krad with parameters of type WorkflowDocument

Modifier and Type	Method and Description
static void	UserSessionUtils.addWorkflowDocument(UserSession userSession, WorkflowDocument workflowDocument) Adds the given WorkflowDocument to the UserSession.

Uses of WorkflowDocument in org.kuali.rice.krad.bo

Methods in org.kuali.rice.krad.bo that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	DocumentHeader.getWorkflowDocument() Returns an instance of the the WorkflowDocument associated with this document header.

Methods in org.kuali.rice.krad.bo with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	DocumentHeader.setWorkflowDocument(WorkflowDocument workflowDocument) Associates a WorkflowDocument with this document header.

Uses of WorkflowDocument in org.kuali.rice.krad.service

Methods in org.kuali.rice.krad.service that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	SessionDocumentService.getDocumentFromSession(UserSession userSession, String docId) Deprecated. Retrieves a document from the user session for the given document id

Methods in org.kuali.rice.krad.service with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	SessionDocumentService.addDocumentToUserSession(UserSession userSession, WorkflowDocument document) Deprecated. This method places a document into the user session.

Uses of WorkflowDocument in org.kuali.rice.krad.service.impl

Methods in org.kuali.rice.krad.service.impl that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	SessionDocumentServiceImpl.getDocumentFromSession(UserSession userSession, String docId) Deprecated. (Deprecated and removed from use in KRAD (KULRICE-9149)

Methods in org.kuali.rice.krad.service.impl with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	SessionDocumentServiceImpl.addDocumentToUserSession(UserSession userSession, WorkflowDocument document) Deprecated. (Deprecated and removed from use in KRAD (KULRICE-9149) *

Uses of WorkflowDocument in org.kuali.rice.krad.web.form

Methods in org.kuali.rice.krad.web.form that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	DocumentFormBase.getWorkflowDocument() Retrieves the WorkflowDocument instance from the forms document instance

Uses of WorkflowDocument in org.kuali.rice.krad.workflow.service

Methods in org.kuali.rice.krad.workflow.service that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	WorkflowDocumentService.createWorkflowDocument(String documentTypeName, Person workflowUser) Given a documentTypeName and workflowUser, returns a new workflowDocument from the workflow server.
WorkflowDocument	WorkflowDocumentService.loadWorkflowDocument(String documentHeaderId, Person workflowUser) Given a documentHeaderId and workflowUser, retrieves the workflowDocument associated with that documentHeaderId from the workflow server.

Methods in org.kuali.rice.krad.workflow.service with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	WorkflowDocumentService.acknowledge(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) acknowledge this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, additionally optionally providing a list of ad hoc recipients for this document which should be restricted to actions requested of acknowledge or fyi as all other action request types will be discarded
void	WorkflowDocumentService.approve(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) approve this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, and additionally optionally providing a list of ad hoc recipients for the document
void	WorkflowDocumentService.blanketApprove(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) blanket approve this document optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, and additionally optionally providing a list of ad hoc recipients for this document which should be restricted to actions requested of acknowledge or fyi as all other action request types will be discarded.
void	WorkflowDocumentService.cancel(WorkflowDocument workflowDocument, String annotation) cancel this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
void	WorkflowDocumentService.clearFyi(WorkflowDocument workflowDocument, List<AdHocRouteRecipient> adHocRecipients) clear the fyi request for this document, optinoally providing a list of ad hoc recipients for this document which should be restricted to actions requested of fyi as all other action request types will be discarded
void	WorkflowDocumentService.complete(WorkflowDocument workflowDocument, String annotation, List adHocRecipients) Completes document
void	WorkflowDocumentService.disapprove(WorkflowDocument workflowDocument, String annotation) disapprove this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
String	WorkflowDocumentService.getCurrentRouteLevelName(WorkflowDocument workflowDocument) Gets the current route level name of the workflow document even if document has no active node names.
String	WorkflowDocumentService.getCurrentRouteNodeNames(WorkflowDocument workflowDocument) Returns the current node names of the document delimited by ", " if there is more than one.
void	WorkflowDocumentService.recall(WorkflowDocument workflowDocument, String annotation, boolean cancel) recall this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
void	WorkflowDocumentService.route(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) route this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, and additionally optionally providing a list of ad hoc recipients for the document
void	WorkflowDocumentService.save(WorkflowDocument workflowDocument, String annotation) This method will first determine if the saveDocument(String) method is valid to be called.
void	WorkflowDocumentService.saveRoutingData(WorkflowDocument workflowDocument) save the routing data of the document to workflow
void	WorkflowDocumentService.sendWorkflowNotification(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) Sends workflow notification to the list of ad hoc recipients.
void	WorkflowDocumentService.sendWorkflowNotification(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients, String notificationLabel) Sends workflow notification to the list of ad hoc recipients.
void	WorkflowDocumentService.superUserApprove(WorkflowDocument workflowDocument, String annotation) super user approve this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
void	WorkflowDocumentService.superUserCancel(WorkflowDocument workflowDocument, String annotation) super user cancel this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
void	WorkflowDocumentService.superUserDisapprove(WorkflowDocument workflowDocument, String annotation) super user disapprove this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken

Uses of WorkflowDocument in org.kuali.rice.krad.workflow.service.impl

Methods in org.kuali.rice.krad.workflow.service.impl that return WorkflowDocument

Modifier and Type	Method and Description
WorkflowDocument	WorkflowDocumentServiceImpl.createWorkflowDocument(String documentTypeName, Person person)
WorkflowDocument	WorkflowDocumentServiceImpl.loadWorkflowDocument(String documentId, Person user)

Methods in org.kuali.rice.krad.workflow.service.impl with parameters of type WorkflowDocument

Modifier and Type	Method and Description
void	WorkflowDocumentServiceImpl.acknowledge(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
void	WorkflowDocumentServiceImpl.approve(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
void	WorkflowDocumentServiceImpl.blanketApprove(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
void	WorkflowDocumentServiceImpl.cancel(WorkflowDocument workflowDocument, String annotation)
void	WorkflowDocumentServiceImpl.clearFyi(WorkflowDocument workflowDocument, List<AdHocRouteRecipient> adHocRecipients)
void	WorkflowDocumentServiceImpl.complete(WorkflowDocument workflowDocument, String annotation, List adHocRecipients) Completes workflow document
void	WorkflowDocumentServiceImpl.disapprove(WorkflowDocument workflowDocument, String annotation)
String	WorkflowDocumentServiceImpl.getCurrentRouteLevelName(WorkflowDocument workflowDocument)
String	WorkflowDocumentServiceImpl.getCurrentRouteNodeNames(WorkflowDocument workflowDocument)
void	WorkflowDocumentServiceImpl.recall(WorkflowDocument workflowDocument, String annotation, boolean cancel)
void	WorkflowDocumentServiceImpl.route(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
void	WorkflowDocumentServiceImpl.save(WorkflowDocument workflowDocument, String annotation)
void	WorkflowDocumentServiceImpl.saveRoutingData(WorkflowDocument workflowDocument)
void	WorkflowDocumentServiceImpl.sendWorkflowNotification(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
void	WorkflowDocumentServiceImpl.sendWorkflowNotification(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients, String notificationLabel)
void	WorkflowDocumentServiceImpl.superUserApprove(WorkflowDocument workflowDocument, String annotation)
void	WorkflowDocumentServiceImpl.superUserCancel(WorkflowDocument workflowDocument, String annotation)
void	WorkflowDocumentServiceImpl.superUserDisapprove(WorkflowDocument workflowDocument, String annotation)