org.kuali.rice.kew.service
Interface WorkflowUtility

public interface WorkflowUtility

A remotable service which provides an API for performing various queries and other utilities on KEW.

Author:

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

Method Summary

void	addDocumentLink(DocumentLinkDTO docLinkVO)
void	deleteDocumentLink(DocumentLinkDTO docLinkVO)
void	deleteDocumentLinksByDocId(Long docId)
boolean	documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO reportCriteriaDTO, String[] actionRequestedCodes, boolean ignoreCurrentActionRequests)
ActionItemDTO[]	getActionItems(Long documentId, String[] actionRequestedCodes)
ActionItemDTO[]	getActionItemsForPrincipal(String principalId)
ActionRequestDTO[]	getActionRequests(Long documentId, String nodeName, String principalId)
org.kuali.rice.core.xml.dto.AttributeSet	getActionsRequested(String principalId, Long documentId)
ActionTakenDTO[]	getActionsTaken(Long documentId)
RouteNodeInstanceDTO[]	getActiveNodeInstances(Long documentId)
ActionItemDTO[]	getAllActionItems(Long documentId)
ActionRequestDTO[]	getAllActionRequests(Long documentId)
String	getAppDocId(Long documentId)
String	getClearFutureRequestsValue()
RouteNodeInstanceDTO[]	getCurrentNodeInstances(Long documentId)
DocumentContentDTO	getDocumentContent(Long documentId)
DocumentDetailDTO	getDocumentDetail(Long documentId)
DocumentDetailDTO	getDocumentDetailFromAppId(String documentTypeName, String appId)
String	getDocumentInitiatorPrincipalId(Long documentId) Returns the principal ID of the initiator of the given document.
String	getDocumentRoutedByPrincipalId(Long documentId) Returns the principal ID of the user who routed the given document.
RouteNodeInstanceDTO[]	getDocumentRouteNodeInstances(Long documentId)
String	getDocumentStatus(Long documentId)
DocumentStatusTransitionDTO[]	getDocumentStatusTransitionHistory(Long routeHeaderId)
DocumentTypeDTO	getDocumentType(Long documentTypeId)
DocumentTypeDTO	getDocumentTypeByName(String documentTypeName)
String	getDoNotReceiveFutureRequestsValue()
String	getFutureRequestsKey(String principalId)
DocumentLinkDTO	getLinkedDocument(DocumentLinkDTO docLinkVO)
List<DocumentLinkDTO>	getLinkedDocumentsByDocId(Long id)
Long	getNewResponsibilityId()
RouteNodeInstanceDTO	getNodeInstance(Long nodeInstanceId)
String[]	getPreviousRouteNodeNames(Long documentId)
String[]	getPrincipalIdsInRouteLog(Long documentId, boolean lookFuture) This method gets a list of ids of all principals in the route log - - initiators, - people who have taken action, - people with a pending action request, - people who will receive an action request for the document in question
String[]	getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId(String actionRequestedCd, Long documentId) This method gets a list of ids of all principals who have a pending action request for a document.
String	getReceiveFutureRequestsValue()
RouteHeaderDTO	getRouteHeader(Long documentId)
RouteHeaderDTO	getRouteHeaderWithPrincipal(String principalId, Long documentId)
Timestamp[]	getSearchableAttributeDateTimeValuesByKey(Long documentId, String key) This method does a direct search for the searchableAttribute without going through the doc search.
BigDecimal[]	getSearchableAttributeFloatValuesByKey(Long documentId, String key) This method does a direct search for the searchableAttribute without going through the doc search.
Long[]	getSearchableAttributeLongValuesByKey(Long documentId, String key) This method does a direct search for the searchableAttribute without going through the doc search.
String[]	getSearchableAttributeStringValuesByKey(Long documentId, String key) This method does a direct search for the searchableAttribute without going through the doc search.
RouteNodeInstanceDTO[]	getTerminalNodeInstances(Long documentId)
Integer	getUserActionItemCount(String principalId)
boolean	hasRouteNode(String documentTypeName, String routeNodeName)
boolean	isCurrentActiveDocumentType(String documentTypeName)
boolean	isFinalApprover(Long documentId, String principalId)
boolean	isLastApproverAtNode(Long documentId, String principalId, String nodeName)
boolean	isLastApproverInRouteLevel(Long documentId, String principalId, Integer routeLevel) Deprecated. use isLastApproverAtNode instead
boolean	isSuperUserForDocumentType(String principalId, Long documentTypeId)
boolean	isUserInRouteLog(Long documentId, String principalId, boolean lookFuture)
boolean	isUserInRouteLogWithOptionalFlattening(Long documentId, String principalId, boolean lookFuture, boolean flattenNodes)
DocumentSearchResultDTO	performDocumentSearch(DocumentSearchCriteriaDTO criteriaVO)
DocumentSearchResultDTO	performDocumentSearchWithPrincipal(String principalId, DocumentSearchCriteriaDTO criteriaVO)
void	reResolveRole(String documentTypeName, String roleName, String qualifiedRoleNameLabel)
void	reResolveRoleByDocumentId(Long documentId, String roleName, String qualifiedRoleNameLabel)
boolean	routeLevelHasApproverActionRequest(String docType, String docContent, Integer routeLevel) Deprecated. use routeNodeHasApproverActionRequest instead
boolean	routeNodeHasApproverActionRequest(String docType, String docContent, String nodeName)
DocumentDetailDTO	routingReport(ReportCriteriaDTO reportCriteria)
RuleDTO[]	ruleReport(RuleReportCriteriaDTO ruleReportCriteria)
WorkflowAttributeValidationErrorDTO[]	validateWorkflowAttributeDefinitionVO(WorkflowAttributeDefinitionDTO definition)

Method Detail

getDocumentDetailFromAppId

DocumentDetailDTO getDocumentDetailFromAppId(String documentTypeName,
                                             String appId)
                                             throws WorkflowException

Throws:

WorkflowException

getRouteHeaderWithPrincipal

RouteHeaderDTO getRouteHeaderWithPrincipal(String principalId,
                                           Long documentId)
                                           throws WorkflowException

Throws:

WorkflowException

getRouteHeader

RouteHeaderDTO getRouteHeader(Long documentId)
                              throws WorkflowException

Throws:

WorkflowException

getDocumentDetail

DocumentDetailDTO getDocumentDetail(Long documentId)
                                    throws WorkflowException

Throws:

WorkflowException

getNodeInstance

RouteNodeInstanceDTO getNodeInstance(Long nodeInstanceId)
                                     throws WorkflowException

Throws:

WorkflowException

getDocumentType

DocumentTypeDTO getDocumentType(Long documentTypeId)
                                throws WorkflowException

Throws:

WorkflowException

getDocumentTypeByName

DocumentTypeDTO getDocumentTypeByName(String documentTypeName)
                                      throws WorkflowException

Throws:

WorkflowException

getNewResponsibilityId

Long getNewResponsibilityId()
                            throws WorkflowException

Throws:

WorkflowException

getUserActionItemCount

Integer getUserActionItemCount(String principalId)
                               throws WorkflowException

Throws:

WorkflowException

getAllActionItems

ActionItemDTO[] getAllActionItems(Long documentId)
                                  throws WorkflowException

Throws:

WorkflowException

getActionItems

ActionItemDTO[] getActionItems(Long documentId,
                               String[] actionRequestedCodes)
                               throws WorkflowException

Throws:

WorkflowException

getAllActionRequests

ActionRequestDTO[] getAllActionRequests(Long documentId)
                                        throws WorkflowException

Throws:

WorkflowException

getActionRequests

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

Throws:

WorkflowException

getActionsTaken

ActionTakenDTO[] getActionsTaken(Long documentId)
                                 throws WorkflowException

Throws:

WorkflowException

validateWorkflowAttributeDefinitionVO

WorkflowAttributeValidationErrorDTO[] validateWorkflowAttributeDefinitionVO(WorkflowAttributeDefinitionDTO definition)
                                                                            throws WorkflowException

Throws:

WorkflowException

isUserInRouteLog

boolean isUserInRouteLog(Long documentId,
                         String principalId,
                         boolean lookFuture)
                         throws WorkflowException

Throws:

WorkflowException

isUserInRouteLogWithOptionalFlattening

boolean isUserInRouteLogWithOptionalFlattening(Long documentId,
                                               String principalId,
                                               boolean lookFuture,
                                               boolean flattenNodes)
                                               throws WorkflowException

Throws:

WorkflowException

reResolveRole

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

Throws:

WorkflowException

reResolveRoleByDocumentId

void reResolveRoleByDocumentId(Long documentId,
                               String roleName,
                               String qualifiedRoleNameLabel)
                               throws WorkflowException

Throws:

WorkflowException

routingReport

DocumentDetailDTO routingReport(ReportCriteriaDTO reportCriteria)
                                throws WorkflowException

Throws:

WorkflowException

isFinalApprover

boolean isFinalApprover(Long documentId,
                        String principalId)
                        throws WorkflowException

Throws:

WorkflowException

isSuperUserForDocumentType

boolean isSuperUserForDocumentType(String principalId,
                                   Long documentTypeId)
                                   throws WorkflowException

Throws:

WorkflowException

getAppDocId

String getAppDocId(Long documentId)

performDocumentSearch

DocumentSearchResultDTO performDocumentSearch(DocumentSearchCriteriaDTO criteriaVO)
                                              throws WorkflowException

Throws:

WorkflowException

performDocumentSearchWithPrincipal

DocumentSearchResultDTO performDocumentSearchWithPrincipal(String principalId,
                                                           DocumentSearchCriteriaDTO criteriaVO)
                                                           throws WorkflowException

Throws:

WorkflowException

ruleReport

RuleDTO[] ruleReport(RuleReportCriteriaDTO ruleReportCriteria)
                     throws WorkflowException

Throws:

WorkflowException

isLastApproverInRouteLevel

boolean isLastApproverInRouteLevel(Long documentId,
                                   String principalId,
                                   Integer routeLevel)
                                   throws WorkflowException

Deprecated. use isLastApproverAtNode instead

Throws:

WorkflowException

routeLevelHasApproverActionRequest

boolean routeLevelHasApproverActionRequest(String docType,
                                           String docContent,
                                           Integer routeLevel)
                                           throws WorkflowException

Deprecated. use routeNodeHasApproverActionRequest instead

Throws:

WorkflowException

isLastApproverAtNode

boolean isLastApproverAtNode(Long documentId,
                             String principalId,
                             String nodeName)
                             throws WorkflowException

Throws:

WorkflowException

routeNodeHasApproverActionRequest

boolean routeNodeHasApproverActionRequest(String docType,
                                          String docContent,
                                          String nodeName)
                                          throws WorkflowException

Throws:

WorkflowException

getDocumentRouteNodeInstances

RouteNodeInstanceDTO[] getDocumentRouteNodeInstances(Long documentId)
                                                     throws WorkflowException

Throws:

WorkflowException

getActiveNodeInstances

RouteNodeInstanceDTO[] getActiveNodeInstances(Long documentId)
                                              throws WorkflowException

Throws:

WorkflowException

getTerminalNodeInstances

RouteNodeInstanceDTO[] getTerminalNodeInstances(Long documentId)
                                                throws WorkflowException

Throws:

WorkflowException

getDocumentContent

DocumentContentDTO getDocumentContent(Long documentId)
                                      throws WorkflowException

Throws:

WorkflowException

getPreviousRouteNodeNames

String[] getPreviousRouteNodeNames(Long documentId)
                                   throws WorkflowException

Throws:

WorkflowException

documentWillHaveAtLeastOneActionRequest

boolean documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO reportCriteriaDTO,
                                                String[] actionRequestedCodes,
                                                boolean ignoreCurrentActionRequests)

getDocumentStatus

String getDocumentStatus(Long documentId)
                         throws WorkflowException

Throws:

WorkflowException

Since:

0.9.1

getCurrentNodeInstances

RouteNodeInstanceDTO[] getCurrentNodeInstances(Long documentId)
                                               throws WorkflowException

Throws:

WorkflowException

getActionItemsForPrincipal

ActionItemDTO[] getActionItemsForPrincipal(String principalId)
                                           throws WorkflowException

Throws:

WorkflowException

getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId

String[] getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId(String actionRequestedCd,
                                                                          Long documentId)
                                                                          throws WorkflowException

This method gets a list of ids of all principals who have a pending action request for a document.

Parameters:

actionRequestedCd -

documentId -

Returns:

Throws:

WorkflowException

getPrincipalIdsInRouteLog

String[] getPrincipalIdsInRouteLog(Long documentId,
                                   boolean lookFuture)
                                   throws WorkflowException

This method gets a list of ids of all principals in the route log - - initiators, - people who have taken action, - people with a pending action request, - people who will receive an action request for the document in question

Parameters:

documentId -

lookFuture -

Returns:

Throws:

WorkflowException

getDocumentInitiatorPrincipalId

String getDocumentInitiatorPrincipalId(Long documentId)
                                       throws WorkflowException

Returns the principal ID of the initiator of the given document. null if the document can not be found.

Throws:

WorkflowException

getDocumentRoutedByPrincipalId

String getDocumentRoutedByPrincipalId(Long documentId)
                                      throws WorkflowException

Returns the principal ID of the user who routed the given document. null if the document can not be found.

Throws:

WorkflowException

getActionsRequested

org.kuali.rice.core.xml.dto.AttributeSet getActionsRequested(String principalId,
                                                             Long documentId)

getSearchableAttributeStringValuesByKey

String[] getSearchableAttributeStringValuesByKey(Long documentId,
                                                 String key)

This method does a direct search for the searchableAttribute without going through the doc search.

Parameters:

documentId -

key -

Returns:

getSearchableAttributeDateTimeValuesByKey

Timestamp[] getSearchableAttributeDateTimeValuesByKey(Long documentId,
                                                      String key)

This method does a direct search for the searchableAttribute without going through the doc search.

Parameters:

documentId -

key -

Returns:

getSearchableAttributeFloatValuesByKey

BigDecimal[] getSearchableAttributeFloatValuesByKey(Long documentId,
                                                    String key)

This method does a direct search for the searchableAttribute without going through the doc search.

Parameters:

documentId -

key -

Returns:

getSearchableAttributeLongValuesByKey

Long[] getSearchableAttributeLongValuesByKey(Long documentId,
                                             String key)

This method does a direct search for the searchableAttribute without going through the doc search.

Parameters:

documentId -

key -

Returns:

getFutureRequestsKey

String getFutureRequestsKey(String principalId)

getReceiveFutureRequestsValue

String getReceiveFutureRequestsValue()

getDoNotReceiveFutureRequestsValue

String getDoNotReceiveFutureRequestsValue()

getClearFutureRequestsValue

String getClearFutureRequestsValue()

hasRouteNode

boolean hasRouteNode(String documentTypeName,
                     String routeNodeName)
                     throws WorkflowException

Throws:

WorkflowException

isCurrentActiveDocumentType

boolean isCurrentActiveDocumentType(String documentTypeName)
                                    throws WorkflowException

Throws:

WorkflowException

getDocumentStatusTransitionHistory

DocumentStatusTransitionDTO[] getDocumentStatusTransitionHistory(Long routeHeaderId)
                                                                 throws WorkflowException

Throws:

WorkflowException

addDocumentLink

void addDocumentLink(DocumentLinkDTO docLinkVO)
                     throws WorkflowException

Throws:

WorkflowException

deleteDocumentLink

void deleteDocumentLink(DocumentLinkDTO docLinkVO)
                        throws WorkflowException

Throws:

WorkflowException

deleteDocumentLinksByDocId

void deleteDocumentLinksByDocId(Long docId)
                                throws WorkflowException

Throws:

WorkflowException

getLinkedDocumentsByDocId

List<DocumentLinkDTO> getLinkedDocumentsByDocId(Long id)
                                                throws WorkflowException

Throws:

WorkflowException

getLinkedDocument

DocumentLinkDTO getLinkedDocument(DocumentLinkDTO docLinkVO)
                                  throws WorkflowException

Throws:

WorkflowException