org.kuali.kra.service.impl

Class KraWorkflowServiceImpl

java.lang.Object

org.kuali.kra.service.impl.KraWorkflowServiceImpl

All Implemented Interfaces:

KraWorkflowService

public class KraWorkflowServiceImpl
extends Object
implements KraWorkflowService

KRA Workflow Service Implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.kew.api.actionlist.ActionListService	actionListService
protected org.kuali.rice.kew.api.action.WorkflowDocumentActionsService	workflowDocumentActionsService
protected org.kuali.rice.kew.api.document.WorkflowDocumentService	workflowDocumentService

Constructor Summary

Constructors

Constructor and Description
KraWorkflowServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canPerformWorkflowAction(ProposalDevelopmentDocument document)
protected org.kuali.rice.kew.api.actionlist.ActionListService	getActionListService()
protected org.kuali.rice.kew.api.WorkflowDocument	getWorkflowDocument(org.kuali.rice.krad.document.Document doc) Get the corresponding workflow document.
protected org.kuali.rice.kew.api.WorkflowDocument	getWorkflowDocument(org.kuali.rice.krad.document.Document doc, String principalId) This method gets the workflow document using the given principalId.
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 document, 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 document, 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 document, 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 actionRequest) Checks to see if the pending request will complete due to a user requesting to not see future requests.
void	setActionListService(org.kuali.rice.kew.api.actionlist.ActionListService actionListService)
void	setWorkflowDocumentActionsService(org.kuali.rice.kew.api.action.WorkflowDocumentActionsService workflowDocumentActionsService)
void	setWorkflowDocumentService(org.kuali.rice.kew.api.document.WorkflowDocumentService workflowDocumentService)

Methods inherited from class java.lang.Object

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

Field Detail

workflowDocumentActionsService

protected org.kuali.rice.kew.api.action.WorkflowDocumentActionsService workflowDocumentActionsService

workflowDocumentService

protected org.kuali.rice.kew.api.document.WorkflowDocumentService workflowDocumentService

actionListService

protected org.kuali.rice.kew.api.actionlist.ActionListService actionListService

Constructor Detail

KraWorkflowServiceImpl

public KraWorkflowServiceImpl()

Method Detail

setWorkflowDocumentActionsService

public void setWorkflowDocumentActionsService(org.kuali.rice.kew.api.action.WorkflowDocumentActionsService workflowDocumentActionsService)

setWorkflowDocumentService

public void setWorkflowDocumentService(org.kuali.rice.kew.api.document.WorkflowDocumentService workflowDocumentService)

hasWorkflowPermission

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

Description copied from interface: KraWorkflowService

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

Specified by:

hasWorkflowPermission in interface KraWorkflowService

doc - the document

Returns:

true if the person has permission; otherwise false

See Also:

KraWorkflowService.hasWorkflowPermission(java.lang.String, org.kuali.rice.krad.document.Document)

isClosed

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

Description copied from interface: KraWorkflowService

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

Specified by:

isClosed in interface KraWorkflowService

Parameters:

doc - the document

Returns:

true if closed; otherwise false

See Also:

KraWorkflowService.isClosed(org.kuali.rice.krad.document.Document)

isEnRoute

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

Description copied from interface: KraWorkflowService

Is the document currently enroute within workflow?

Specified by:

isEnRoute in interface KraWorkflowService

Parameters:

doc - the document

Returns:

true if enroute; otherwise false

See Also:

KraWorkflowService.isEnRoute(org.kuali.rice.krad.document.Document)

isInWorkflow

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

Description copied from interface: KraWorkflowService

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

Specified by:

isInWorkflow in interface KraWorkflowService

Parameters:

doc - the document

Returns:

true if in workflow; otherwise false

See Also:

KraWorkflowService.isInWorkflow(org.kuali.rice.krad.document.Document)

getWorkflowDocument

protected org.kuali.rice.kew.api.WorkflowDocument getWorkflowDocument(org.kuali.rice.krad.document.Document doc)

Get the corresponding workflow document.

Parameters:

doc - the document

Returns:

the workflow document or null if there is none

getWorkflowDocument

protected org.kuali.rice.kew.api.WorkflowDocument getWorkflowDocument(org.kuali.rice.krad.document.Document doc,
                                                          String principalId)

This method gets the workflow document using the given principalId.

Parameters:

doc - The document you want the workflow document for.

principalId - The principalId to use getting the document. This impacts the return values for isApprovalRequested, etc.

Returns:

isUserApprovalRequested

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

Description copied from interface: KraWorkflowService

Determine if the user has an outstanding approval request.

Specified by:

isUserApprovalRequested in interface KraWorkflowService

Parameters:

doc - the document

principalId - the principalId of the user

Returns:

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

See Also:

KraWorkflowService.isUserApprovalRequested(org.kuali.rice.krad.document.Document, java.lang.String)

isUserActionRequested

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

Description copied from interface: KraWorkflowService

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

Specified by:

isUserActionRequested in interface KraWorkflowService

Parameters:

doc - the document

principalId - the principalId of the user

Returns:

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

See Also:

KraWorkflowService.isUserApprovalRequested(org.kuali.rice.krad.document.Document, java.lang.String)

isDocumentOnNode

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

Description copied from interface: KraWorkflowService

Determine if the document is on a particular node.

Specified by:

isDocumentOnNode in interface KraWorkflowService

Parameters:

document - the document

nodeName - the name of the node.

Returns:

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

See Also:

KraWorkflowService.isDocumentOnNode(org.kuali.rice.krad.document.Document, java.lang.String)

isUserAdHocRequestRecipient

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

Description copied from interface: KraWorkflowService

Determine if the user has an outstanding adHoc request.

Specified by:

isUserAdHocRequestRecipient in interface KraWorkflowService

Parameters:

document - the document

principalId - the principalId of the user

Returns:

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

isUserRouteRespRequestRecipient

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

Description copied from interface: KraWorkflowService

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

Specified by:

isUserRouteRespRequestRecipient in interface KraWorkflowService

Parameters:

document - the document

principalId - the principalId of the user

Returns:

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

populateApproverViewDO

public ProposalDevelopmentApproverViewDO populateApproverViewDO(ProposalDevelopmentForm proposalDevelopmentForm)

Specified by:

populateApproverViewDO in interface KraWorkflowService

canPerformWorkflowAction

public boolean canPerformWorkflowAction(ProposalDevelopmentDocument document)

Specified by:

canPerformWorkflowAction in interface KraWorkflowService

isFinalApproval

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

Description copied from interface: KraWorkflowService

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

Specified by:

isFinalApproval in interface KraWorkflowService

Returns:

See Also:

KraWorkflowService.isFinalApproval(org.kuali.rice.kew.api.WorkflowDocument)

requestAlreadyApproved

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

Description copied from interface: KraWorkflowService

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

Specified by:

requestAlreadyApproved in interface KraWorkflowService

Returns:

See Also:

KraWorkflowService.requestAlreadyApproved(org.kuali.rice.kew.api.WorkflowDocument, org.kuali.rice.kew.api.action.ActionRequest)

hasPendingApprovalRequests

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

Specified by:

hasPendingApprovalRequests in interface KraWorkflowService

getActionListService

protected org.kuali.rice.kew.api.actionlist.ActionListService getActionListService()

setActionListService

public void setActionListService(org.kuali.rice.kew.api.actionlist.ActionListService actionListService)