org.kuali.rice.kns.workflow.service
Interface KualiWorkflowInfo

All Known Implementing Classes:

KualiWorkflowInfoImpl

public interface KualiWorkflowInfo

This class...

Method Summary

boolean	documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO reportCriteriaDTO, String[] actionRequestedCodes) Deprecated. use documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO, String[], boolean) instead Use of this method passes the value 'false' in for the ignoreCurrentlyActiveRequests parameter of documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO, String[], boolean)
boolean	documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO reportCriteriaDTO, String[] actionRequestedCodes, boolean ignoreCurrentlyActiveRequests) Determines if a document generated (or retrieved) using the given criteria has (or will have) an action request using one of the given action request codes.
ActionRequestDTO[]	getActionRequests(Long routeHeaderId)
ActionRequestDTO[]	getActionRequests(Long routeHeaderId, String nodeName, String principalId)
ActionTakenDTO[]	getActionsTaken(Long routeHeaderId)
List<String>	getApprovalRequestedUsers(Long routeHeaderId) This method returns a list of Universal User Ids that have approval or completion requested of them for the document represented by the routeHeaderId parameter
DocumentTypeDTO	getDocType(Long documentTypeId)
DocumentTypeDTO	getDocType(String documentTypeName)
Long	getNewResponsibilityId()
RouteHeaderDTO	getRouteHeader(Long routeHeaderId)
RouteHeaderDTO	getRouteHeader(String principalId, Long routeHeaderId)
boolean	isCurrentActiveDocumentType(String documentTypeName)
DocumentSearchResultDTO	performDocumentSearch(DocumentSearchCriteriaDTO criteriaVO) This method allows a document search to be executed just as would occur from the User Interface
DocumentSearchResultDTO	performDocumentSearch(String principalId, DocumentSearchCriteriaDTO criteriaVO)
void	reResolveRole(Long routeHeaderId, String roleName, String qualifiedRoleNameLabel)
void	reResolveRole(String documentTypeName, String roleName, String qualifiedRoleNameLabel)
boolean	routeHeaderExists(Long routeHeaderId) Determines whether the given routeHeaderId (also known as a documentNumber, or a docHeaderId) exists and is retrievable in workflow.

Method Detail

getRouteHeader

RouteHeaderDTO getRouteHeader(String principalId,
                              Long routeHeaderId)
                              throws WorkflowException

Throws:

WorkflowException

getRouteHeader

RouteHeaderDTO getRouteHeader(Long routeHeaderId)
                              throws WorkflowException

Throws:

WorkflowException

getDocType

DocumentTypeDTO getDocType(Long documentTypeId)
                           throws WorkflowException

Throws:

WorkflowException

getDocType

DocumentTypeDTO getDocType(String documentTypeName)
                           throws WorkflowException

Throws:

WorkflowException

getNewResponsibilityId

Long getNewResponsibilityId()
                            throws WorkflowException

Throws:

WorkflowException

getActionRequests

ActionRequestDTO[] getActionRequests(Long routeHeaderId)
                                     throws WorkflowException

Throws:

WorkflowException

getActionRequests

ActionRequestDTO[] getActionRequests(Long routeHeaderId,
                                     String nodeName,
                                     String principalId)
                                     throws WorkflowException

Throws:

WorkflowException

getActionsTaken

ActionTakenDTO[] getActionsTaken(Long routeHeaderId)
                                 throws WorkflowException

Throws:

WorkflowException

reResolveRole

void reResolveRole(String documentTypeName,
                   String roleName,
                   String qualifiedRoleNameLabel)
                   throws WorkflowException

Throws:

WorkflowException

reResolveRole

void reResolveRole(Long routeHeaderId,
                   String roleName,
                   String qualifiedRoleNameLabel)
                   throws WorkflowException

Throws:

WorkflowException

routeHeaderExists

boolean routeHeaderExists(Long routeHeaderId)

Determines whether the given routeHeaderId (also known as a documentNumber, or a docHeaderId) exists and is retrievable in workflow.

Parameters:

routeHeaderId - The docHeaderId/finDocNumber you would like to test.

Returns:

True if the document exists in workflow and is retrievable without errors, False otherwise.

documentWillHaveAtLeastOneActionRequest

boolean documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO reportCriteriaDTO,
                                                String[] actionRequestedCodes,
                                                boolean ignoreCurrentlyActiveRequests)
                                                throws WorkflowException

Determines if a document generated (or retrieved) using the given criteria has (or will have) an action request using one of the given action request codes. User may or may not pass in a target node name inside the ReportCriteriaDTO object.

Parameters:

reportCriteriaDTO - - Holds either a document type name or a document id as well as other data to help simulate routing

actionRequestedCodes - - List of Action Request Codes from the Workflow system

ignoreCurrentlyActiveRequests - determines if method should look only at simulation generated requests or both simulation generated requests and requests that are currently active on the document

Returns:

true if the document has or will have at least one request that matches the criteria and has a requested code that matches one of the given codes

Throws:

WorkflowException

documentWillHaveAtLeastOneActionRequest

boolean documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO reportCriteriaDTO,
                                                String[] actionRequestedCodes)
                                                throws WorkflowException

Deprecated. use documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO, String[], boolean) instead Use of this method passes the value 'false' in for the ignoreCurrentlyActiveRequests parameter of documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO, String[], boolean)

Throws:

WorkflowException

isCurrentActiveDocumentType

boolean isCurrentActiveDocumentType(String documentTypeName)
                                    throws WorkflowException

Throws:

WorkflowException

getApprovalRequestedUsers

List<String> getApprovalRequestedUsers(Long routeHeaderId)
                                       throws WorkflowException

This method returns a list of Universal User Ids that have approval or completion requested of them for the document represented by the routeHeaderId parameter

Parameters:

routeHeaderId - - the id of the document to check

Returns:

a list of Universal User Ids that have approval or completion requested of them for the document with the given route header id

Throws:

WorkflowException

performDocumentSearch

DocumentSearchResultDTO performDocumentSearch(DocumentSearchCriteriaDTO criteriaVO)
                                              throws WorkflowException

This method allows a document search to be executed just as would occur from the User Interface

Parameters:

criteriaVO - - criteria to use for the search

Returns:

a DocumentSearchResultDTO object containing a list of search result columns and data rows

Throws:

RemoteException

WorkflowException

performDocumentSearch

DocumentSearchResultDTO performDocumentSearch(String principalId,
                                              DocumentSearchCriteriaDTO criteriaVO)
                                              throws RemoteException,
                                                     WorkflowException

Throws:

RemoteException

WorkflowException