org.kuali.kra.service

Interface KraWorkflowService

All Known Implementing Classes:

KraWorkflowServiceImpl

public interface KraWorkflowService

The KRA Workflow Service is simply a set or re-usable functionality to determine the workflow state of a document as well as who can work on the document when it is in workflow.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canPerformWorkflowAction(ProposalDevelopmentDocument document)
boolean	hasPendingApprovalRequests(org.kuali.rice.kew.api.WorkflowDocument workflowDoc)
boolean	hasWorkflowPermission(String userId, org.kuali.rice.krad.document.Document doc) Does the given user have the right to work on the document if the document is in workflow?
boolean	isClosed(org.kuali.rice.krad.document.Document doc) Is the document closed? A closed document has been Approved, Disapproved, Canceled, or encountered an Exception.
boolean	isDocumentOnNode(org.kuali.rice.krad.document.Document doc, String nodeName) Determine if the document is on a particular node.
boolean	isEnRoute(org.kuali.rice.krad.document.Document doc) Is the document currently enroute within workflow?
boolean	isFinalApproval(org.kuali.rice.kew.api.WorkflowDocument workflowDoc) Checks to see if all pending workflow requests are completed or will be completed due to a user not wanting to see future requests.
boolean	isInWorkflow(org.kuali.rice.krad.document.Document doc) Determine if the document has been submitted to workflow or not?
boolean	isUserActionRequested(org.kuali.rice.krad.document.Document doc, String principalId) Determine if the user has an outstanding review action request (A/F/K).
boolean	isUserAdHocRequestRecipient(org.kuali.rice.krad.document.Document doc, String principalId, String nodeName) Determine if the user has an outstanding adHoc request.
boolean	isUserApprovalRequested(org.kuali.rice.krad.document.Document doc, String principalId) Determine if the user has an outstanding approval request.
boolean	isUserRouteRespRequestRecipient(org.kuali.rice.krad.document.Document doc, String principalId, String nodeName) Determine if the user has an outstanding action request though pre-configured responsibility
ProposalDevelopmentApproverViewDO	populateApproverViewDO(ProposalDevelopmentForm proposalDevelopmentForm)
boolean	requestAlreadyApproved(org.kuali.rice.kew.api.WorkflowDocument workflowDoc, org.kuali.rice.kew.api.action.ActionRequest request) Checks to see if the pending request will complete due to a user requesting to not see future requests.

Method Detail

hasWorkflowPermission

boolean hasWorkflowPermission(String userId,
                            org.kuali.rice.krad.document.Document doc)

Does the given user have the right to work on the document if the document is in workflow?

Parameters:

username - the username of the person

doc - the document

Returns:

true if the person has permission; otherwise false

isEnRoute

boolean isEnRoute(org.kuali.rice.krad.document.Document doc)

Is the document currently enroute within workflow?

Parameters:

doc - the document

Returns:

true if enroute; otherwise false

isClosed

boolean isClosed(org.kuali.rice.krad.document.Document doc)

Is the document closed? A closed document has been Approved, Disapproved, Canceled, or encountered an Exception.

Parameters:

doc - the document

Returns:

true if closed; otherwise false

isInWorkflow

boolean isInWorkflow(org.kuali.rice.krad.document.Document doc)

Determine if the document has been submitted to workflow or not?

Parameters:

doc - the document

Returns:

true if in workflow; otherwise false

isUserApprovalRequested

boolean isUserApprovalRequested(org.kuali.rice.krad.document.Document doc,
                              String principalId)

Determine if the user has an outstanding approval request.

Parameters:

doc - the document

principalId - the principalId of the user

Returns:

true if the user has an approval action request pending on the document.

isUserActionRequested

boolean isUserActionRequested(org.kuali.rice.krad.document.Document doc,
                            String principalId)

Determine if the user has an outstanding review action request (A/F/K).

Parameters:

doc - the document

principalId - the principalId of the user

Returns:

true if the user has an action request pending on the document.

isDocumentOnNode

boolean isDocumentOnNode(org.kuali.rice.krad.document.Document doc,
                       String nodeName)

Determine if the document is on a particular node.

Parameters:

doc - the document

nodeName - the name of the node.

Returns:

true if the document is currently on a node with the given name.

isUserAdHocRequestRecipient

boolean isUserAdHocRequestRecipient(org.kuali.rice.krad.document.Document doc,
                                  String principalId,
                                  String nodeName)

Determine if the user has an outstanding adHoc request.

Parameters:

doc - the document

principalId - the principalId of the user

Returns:

true if the user has an adHoc action request pending on the document.

isUserRouteRespRequestRecipient

boolean isUserRouteRespRequestRecipient(org.kuali.rice.krad.document.Document doc,
                                      String principalId,
                                      String nodeName)

Determine if the user has an outstanding action request though pre-configured responsibility

Parameters:

doc - the document

principalId - the principalId of the user

Returns:

true if the user has a action request pending on the document.

populateApproverViewDO

ProposalDevelopmentApproverViewDO populateApproverViewDO(ProposalDevelopmentForm proposalDevelopmentForm)

canPerformWorkflowAction

boolean canPerformWorkflowAction(ProposalDevelopmentDocument document)

isFinalApproval

boolean isFinalApproval(org.kuali.rice.kew.api.WorkflowDocument workflowDoc)

Checks to see if all pending workflow requests are completed or will be completed due to a user not wanting to see future requests.

Parameters:

workflowDoc -

Returns:

requestAlreadyApproved

boolean requestAlreadyApproved(org.kuali.rice.kew.api.WorkflowDocument workflowDoc,
                             org.kuali.rice.kew.api.action.ActionRequest request)

Checks to see if the pending request will complete due to a user requesting to not see future requests.

Parameters:

workflowDoc -

request -

Returns:

hasPendingApprovalRequests

boolean hasPendingApprovalRequests(org.kuali.rice.kew.api.WorkflowDocument workflowDoc)