|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.kuali.rice.kew.service.impl.WorkflowUtilityWebServiceImpl
public class WorkflowUtilityWebServiceImpl
Field Summary | |
---|---|
private static org.apache.log4j.Logger |
LOG
|
Constructor Summary | |
---|---|
WorkflowUtilityWebServiceImpl()
|
Method Summary | |
---|---|
private boolean |
actionRequestListHasPrincipal(KimPrincipal principal,
List actionRequests)
|
private boolean |
actionRequestMatches(ActionRequestValue actionRequest,
String nodeName,
String principalId)
|
void |
addDocumentLink(DocumentLinkDTO docLinkVO)
This overridden method ... |
private RouteNodeInstanceDTO[] |
convertRouteNodeInstances(List nodeInstances)
|
void |
deleteDocumentLink(DocumentLinkDTO docLink)
|
void |
deleteDocumentLinksByDocId(Long id)
This overridden method ... |
boolean |
documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO reportCriteriaDTO,
String[] actionRequestedCodes,
boolean ignoreCurrentActionRequests)
|
ActionItemDTO[] |
getActionItems(Long routeHeaderId,
String[] actionRequestedCodes)
|
ActionItemDTO[] |
getActionItemsForPrincipal(String principalId)
|
ActionRequestDTO[] |
getActionRequests(Long routeHeaderId,
String nodeName,
String principalId)
Returns a flattened list of ActionRequests which match the given criteria. |
AttributeSet |
getActionsRequested(String principalId,
Long documentId)
|
ActionTakenDTO[] |
getActionsTaken(Long routeHeaderId)
|
RouteNodeInstanceDTO[] |
getActiveNodeInstances(Long documentId)
|
ActionItemDTO[] |
getAllActionItems(Long routeHeaderId)
|
ActionRequestDTO[] |
getAllActionRequests(Long routeHeaderId)
|
String |
getAppDocId(Long documentId)
|
String |
getClearFutureRequestsValue()
|
RouteNodeInstanceDTO[] |
getCurrentNodeInstances(Long documentId)
|
DocumentContentDTO |
getDocumentContent(Long routeHeaderId)
|
DocumentDetailDTO |
getDocumentDetail(Long documentId)
|
DocumentDetailDTO |
getDocumentDetailFromAppId(String documentTypeName,
String appId)
|
String |
getDocumentInitiatorPrincipalId(Long routeHeaderId)
Returns the principal ID of the initiator of the given document. |
String |
getDocumentRoutedByPrincipalId(Long routeHeaderId)
Returns the principal ID of the user who routed the given document. |
RouteNodeInstanceDTO[] |
getDocumentRouteNodeInstances(Long documentId)
|
String |
getDocumentStatus(Long documentId)
|
DocumentStatusTransitionDTO[] |
getDocumentStatusTransitionHistory(Long documentId)
|
DocumentTypeDTO |
getDocumentType(Long documentTypeId)
|
DocumentTypeDTO |
getDocumentTypeByName(String documentTypeName)
|
String |
getDoNotReceiveFutureRequestsValue()
|
String |
getFutureRequestsKey(String principalId)
|
DocumentLinkDTO |
getLinkedDocument(DocumentLinkDTO docLinkVO)
This overridden method ... |
List<DocumentLinkDTO> |
getLinkedDocumentsByDocId(Long id)
This overridden method ... |
Long |
getNewResponsibilityId()
|
RouteNodeInstanceDTO |
getNodeInstance(Long nodeInstanceId)
|
String[] |
getPreviousRouteNodeNames(Long documentId)
|
private List<String> |
getPrincipalIdsForActionRequest(ActionRequestValue actionRequest)
This method gets all of the principalIds for the given ActionRequestValue. |
String[] |
getPrincipalIdsInRouteLog(Long routeHeaderId,
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 routeHeaderId)
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)
|
private void |
incomingParamCheck(Object object,
String name)
|
private DocumentLink |
initDocLink(DocumentLinkDTO docLinkVO)
|
boolean |
isCurrentActiveDocumentType(String documentTypeName)
|
boolean |
isFinalApprover(Long routeHeaderId,
String principalId)
|
boolean |
isLastApproverAtNode(Long routeHeaderId,
String principalId,
String nodeName)
|
boolean |
isLastApproverInRouteLevel(Long routeHeaderId,
String principalId,
Integer routeLevel)
|
private boolean |
isRecipientRoutedRequest(ActionRequestValue actionRequest,
List<Recipient> recipients)
|
boolean |
isSuperUserForDocumentType(String principalId,
Long documentTypeId)
|
boolean |
isUserInRouteLog(Long routeHeaderId,
String principalId,
boolean lookFuture)
|
boolean |
isUserInRouteLogWithOptionalFlattening(Long routeHeaderId,
String principalId,
boolean lookFuture,
boolean flattenNodes)
|
private DocumentRouteHeaderValue |
loadDocument(Long documentId)
|
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 documentTypeName,
String docContent,
Integer routeLevel)
Deprecated. use routeNodeHasApproverActionRequest instead |
private boolean |
routeNodeHasApproverActionRequest(DocumentType documentType,
String docContent,
RouteNode node,
Integer routeLevel)
Really this method needs to be implemented using the routingReport functionality (the SimulationEngine). |
boolean |
routeNodeHasApproverActionRequest(String documentTypeName,
String docContent,
String nodeName)
|
DocumentDetailDTO |
routingReport(ReportCriteriaDTO reportCriteria)
|
RuleDTO[] |
ruleReport(RuleReportCriteriaDTO ruleReportCriteria)
|
WorkflowAttributeValidationErrorDTO[] |
validateWorkflowAttributeDefinitionVO(WorkflowAttributeDefinitionDTO definition)
This work is also being done in the bowels of convertDocumentContentVO in DTOConverter so some code could be reduced. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final org.apache.log4j.Logger LOG
Constructor Detail |
---|
public WorkflowUtilityWebServiceImpl()
Method Detail |
---|
public RouteHeaderDTO getRouteHeaderWithPrincipal(String principalId, Long documentId) throws WorkflowException
getRouteHeaderWithPrincipal
in interface WorkflowUtility
WorkflowException
public AttributeSet getActionsRequested(String principalId, Long documentId)
getActionsRequested
in interface WorkflowUtility
public RouteHeaderDTO getRouteHeader(Long documentId) throws WorkflowException
getRouteHeader
in interface WorkflowUtility
WorkflowException
public String getDocumentStatus(Long documentId) throws WorkflowException
getDocumentStatus
in interface WorkflowUtility
WorkflowException
public DocumentDetailDTO getDocumentDetail(Long documentId) throws WorkflowException
getDocumentDetail
in interface WorkflowUtility
WorkflowException
public RouteNodeInstanceDTO getNodeInstance(Long nodeInstanceId) throws WorkflowException
getNodeInstance
in interface WorkflowUtility
WorkflowException
public DocumentTypeDTO getDocumentType(Long documentTypeId) throws WorkflowException
getDocumentType
in interface WorkflowUtility
WorkflowException
public DocumentTypeDTO getDocumentTypeByName(String documentTypeName) throws WorkflowException
getDocumentTypeByName
in interface WorkflowUtility
WorkflowException
public Long getNewResponsibilityId()
getNewResponsibilityId
in interface WorkflowUtility
public Integer getUserActionItemCount(String principalId) throws WorkflowException
getUserActionItemCount
in interface WorkflowUtility
WorkflowException
public ActionItemDTO[] getActionItemsForPrincipal(String principalId) throws WorkflowException
getActionItemsForPrincipal
in interface WorkflowUtility
WorkflowException
public ActionItemDTO[] getAllActionItems(Long routeHeaderId) throws WorkflowException
getAllActionItems
in interface WorkflowUtility
WorkflowException
public ActionItemDTO[] getActionItems(Long routeHeaderId, String[] actionRequestedCodes) throws WorkflowException
getActionItems
in interface WorkflowUtility
WorkflowException
public ActionRequestDTO[] getAllActionRequests(Long routeHeaderId) throws WorkflowException
getAllActionRequests
in interface WorkflowUtility
WorkflowException
public ActionRequestDTO[] getActionRequests(Long routeHeaderId, String nodeName, String principalId) throws WorkflowException
getActionRequests
in interface WorkflowUtility
WorkflowException
private boolean actionRequestMatches(ActionRequestValue actionRequest, String nodeName, String principalId) throws WorkflowException
WorkflowException
public ActionTakenDTO[] getActionsTaken(Long routeHeaderId) throws WorkflowException
getActionsTaken
in interface WorkflowUtility
WorkflowException
public WorkflowAttributeValidationErrorDTO[] validateWorkflowAttributeDefinitionVO(WorkflowAttributeDefinitionDTO definition) throws WorkflowException
validateWorkflowAttributeDefinitionVO
in interface WorkflowUtility
definition
-
WorkflowException
public RouteNodeInstanceDTO[] getDocumentRouteNodeInstances(Long documentId) throws WorkflowException
getDocumentRouteNodeInstances
in interface WorkflowUtility
WorkflowException
public RouteNodeInstanceDTO[] getActiveNodeInstances(Long documentId) throws WorkflowException
getActiveNodeInstances
in interface WorkflowUtility
WorkflowException
public RouteNodeInstanceDTO[] getTerminalNodeInstances(Long documentId) throws WorkflowException
getTerminalNodeInstances
in interface WorkflowUtility
WorkflowException
public RouteNodeInstanceDTO[] getCurrentNodeInstances(Long documentId) throws WorkflowException
getCurrentNodeInstances
in interface WorkflowUtility
WorkflowException
private RouteNodeInstanceDTO[] convertRouteNodeInstances(List nodeInstances) throws WorkflowException
WorkflowException
public boolean isUserInRouteLog(Long routeHeaderId, String principalId, boolean lookFuture) throws WorkflowException
isUserInRouteLog
in interface WorkflowUtility
WorkflowException
public boolean isUserInRouteLogWithOptionalFlattening(Long routeHeaderId, String principalId, boolean lookFuture, boolean flattenNodes) throws WorkflowException
isUserInRouteLogWithOptionalFlattening
in interface WorkflowUtility
WorkflowException
public String[] getPrincipalIdsInRouteLog(Long routeHeaderId, boolean lookFuture) throws WorkflowException
WorkflowUtility
getPrincipalIdsInRouteLog
in interface WorkflowUtility
WorkflowException
WorkflowUtility.getPrincipalIdsInRouteLog(java.lang.Long, boolean)
private List<String> getPrincipalIdsForActionRequest(ActionRequestValue actionRequest)
actionRequest
- public String[] getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId(String actionRequestedCd, Long routeHeaderId)
WorkflowUtility
getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId
in interface WorkflowUtility
WorkflowUtility.getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId(java.lang.String, java.lang.Long)
private boolean actionRequestListHasPrincipal(KimPrincipal principal, List actionRequests) throws WorkflowException
WorkflowException
private boolean isRecipientRoutedRequest(ActionRequestValue actionRequest, List<Recipient> recipients) throws WorkflowException
WorkflowException
public boolean documentWillHaveAtLeastOneActionRequest(ReportCriteriaDTO reportCriteriaDTO, String[] actionRequestedCodes, boolean ignoreCurrentActionRequests)
documentWillHaveAtLeastOneActionRequest
in interface WorkflowUtility
WorkflowUtility.documentWillHaveAtLeastOneActionRequest(org.kuali.rice.kew.dto.ReportCriteriaDTO, java.lang.String[], boolean)
public boolean isLastApproverInRouteLevel(Long routeHeaderId, String principalId, Integer routeLevel) throws WorkflowException
isLastApproverInRouteLevel
in interface WorkflowUtility
WorkflowException
public boolean isLastApproverAtNode(Long routeHeaderId, String principalId, String nodeName) throws WorkflowException
isLastApproverAtNode
in interface WorkflowUtility
WorkflowException
public boolean routeLevelHasApproverActionRequest(String documentTypeName, String docContent, Integer routeLevel) throws WorkflowException
routeLevelHasApproverActionRequest
in interface WorkflowUtility
WorkflowException
public boolean routeNodeHasApproverActionRequest(String documentTypeName, String docContent, String nodeName) throws WorkflowException
routeNodeHasApproverActionRequest
in interface WorkflowUtility
WorkflowException
private boolean routeNodeHasApproverActionRequest(DocumentType documentType, String docContent, RouteNode node, Integer routeLevel) throws WorkflowException
WorkflowException
private void incomingParamCheck(Object object, String name)
public void reResolveRole(String documentTypeName, String roleName, String qualifiedRoleNameLabel) throws WorkflowException
reResolveRole
in interface WorkflowUtility
WorkflowException
public void reResolveRoleByDocumentId(Long documentId, String roleName, String qualifiedRoleNameLabel) throws WorkflowException
reResolveRoleByDocumentId
in interface WorkflowUtility
WorkflowException
public DocumentDetailDTO routingReport(ReportCriteriaDTO reportCriteria) throws WorkflowException
routingReport
in interface WorkflowUtility
WorkflowException
public boolean isFinalApprover(Long routeHeaderId, String principalId) throws WorkflowException
isFinalApprover
in interface WorkflowUtility
WorkflowException
public boolean isSuperUserForDocumentType(String principalId, Long documentTypeId) throws WorkflowException
isSuperUserForDocumentType
in interface WorkflowUtility
WorkflowException
private DocumentRouteHeaderValue loadDocument(Long documentId)
public DocumentContentDTO getDocumentContent(Long routeHeaderId) throws WorkflowException
getDocumentContent
in interface WorkflowUtility
WorkflowException
public String[] getPreviousRouteNodeNames(Long documentId) throws WorkflowException
getPreviousRouteNodeNames
in interface WorkflowUtility
WorkflowException
public RuleDTO[] ruleReport(RuleReportCriteriaDTO ruleReportCriteria) throws WorkflowException
ruleReport
in interface WorkflowUtility
WorkflowException
public DocumentSearchResultDTO performDocumentSearch(DocumentSearchCriteriaDTO criteriaVO) throws WorkflowException
performDocumentSearch
in interface WorkflowUtility
WorkflowException
public DocumentSearchResultDTO performDocumentSearchWithPrincipal(String principalId, DocumentSearchCriteriaDTO criteriaVO) throws WorkflowException
performDocumentSearchWithPrincipal
in interface WorkflowUtility
WorkflowException
public String getDocumentInitiatorPrincipalId(Long routeHeaderId) throws WorkflowException
WorkflowUtility
getDocumentInitiatorPrincipalId
in interface WorkflowUtility
WorkflowException
WorkflowUtility.getDocumentInitiatorPrincipalId(java.lang.Long)
public String getDocumentRoutedByPrincipalId(Long routeHeaderId) throws WorkflowException
WorkflowUtility
getDocumentRoutedByPrincipalId
in interface WorkflowUtility
WorkflowException
WorkflowUtility.getDocumentRoutedByPrincipalId(java.lang.Long)
public Timestamp[] getSearchableAttributeDateTimeValuesByKey(Long documentId, String key)
WorkflowUtility
getSearchableAttributeDateTimeValuesByKey
in interface WorkflowUtility
WorkflowUtility.getSearchableAttributeDateTimeValuesByKey(java.lang.Long, java.lang.String)
public BigDecimal[] getSearchableAttributeFloatValuesByKey(Long documentId, String key)
WorkflowUtility
getSearchableAttributeFloatValuesByKey
in interface WorkflowUtility
WorkflowUtility.getSearchableAttributeFloatValuesByKey(java.lang.Long, java.lang.String)
public Long[] getSearchableAttributeLongValuesByKey(Long documentId, String key)
WorkflowUtility
getSearchableAttributeLongValuesByKey
in interface WorkflowUtility
WorkflowUtility.getSearchableAttributeLongValuesByKey(java.lang.Long, java.lang.String)
public String[] getSearchableAttributeStringValuesByKey(Long documentId, String key)
WorkflowUtility
getSearchableAttributeStringValuesByKey
in interface WorkflowUtility
WorkflowUtility.getSearchableAttributeStringValuesByKey(java.lang.Long, java.lang.String)
public String getFutureRequestsKey(String principalId)
getFutureRequestsKey
in interface WorkflowUtility
public String getReceiveFutureRequestsValue()
getReceiveFutureRequestsValue
in interface WorkflowUtility
public String getDoNotReceiveFutureRequestsValue()
getDoNotReceiveFutureRequestsValue
in interface WorkflowUtility
public String getClearFutureRequestsValue()
getClearFutureRequestsValue
in interface WorkflowUtility
public boolean hasRouteNode(String documentTypeName, String routeNodeName) throws WorkflowException
hasRouteNode
in interface WorkflowUtility
WorkflowException
public boolean isCurrentActiveDocumentType(String documentTypeName) throws WorkflowException
isCurrentActiveDocumentType
in interface WorkflowUtility
WorkflowException
public DocumentDetailDTO getDocumentDetailFromAppId(String documentTypeName, String appId) throws WorkflowException
getDocumentDetailFromAppId
in interface WorkflowUtility
WorkflowException
public String getAppDocId(Long documentId)
getAppDocId
in interface WorkflowUtility
public DocumentStatusTransitionDTO[] getDocumentStatusTransitionHistory(Long documentId) throws WorkflowException
getDocumentStatusTransitionHistory
in interface WorkflowUtility
WorkflowException
public void deleteDocumentLink(DocumentLinkDTO docLink) throws WorkflowException
deleteDocumentLink
in interface WorkflowUtility
WorkflowException
public void addDocumentLink(DocumentLinkDTO docLinkVO) throws WorkflowException
addDocumentLink
in interface WorkflowUtility
WorkflowException
org.kuali.rice.kew.routeheader.service.WorkflowDocumentService#addDocumentLink(org.kuali.rice.kew.documentlink.DocumentLink)
public List<DocumentLinkDTO> getLinkedDocumentsByDocId(Long id) throws WorkflowException
getLinkedDocumentsByDocId
in interface WorkflowUtility
WorkflowException
org.kuali.rice.kew.routeheader.service.WorkflowDocumentService#getgetLinkedDocumentsByDocId(java.lang.Long)
public DocumentLinkDTO getLinkedDocument(DocumentLinkDTO docLinkVO) throws WorkflowException
getLinkedDocument
in interface WorkflowUtility
WorkflowException
org.kuali.rice.kew.routeheader.service.WorkflowDocumentService#getDocumentLink(org.kuali.rice.kew.documentlink.DocumentLink)
public void deleteDocumentLinksByDocId(Long id) throws WorkflowException
deleteDocumentLinksByDocId
in interface WorkflowUtility
WorkflowException
org.kuali.rice.kew.routeheader.service.WorkflowDocumentService#deleteDocumentLinkByDocId(java.lang.Long)
private DocumentLink initDocLink(DocumentLinkDTO docLinkVO)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |