| java.lang.Object
 edu.iu.uis.eden.clientapp.WorkflowInfo
| WorkflowInfo | | public class WorkflowInfo implements java.io.Serializable(Code) | | Convenience class for client applications to query workflow. This class is one of two
(Java) client interfaces to the KEW system (the other being
WorkflowDocument class).
The first time an instance of this class is created, it will read the client configuration to
determine how to connect to KEW. To use this API, simply create a new instance using the
empty constructor.
author:
rkirkend
author:
ewestfal |
| Method Summary | |
| public boolean | documentWillHaveAtLeastOneActionRequest(ReportCriteriaVO reportCriteriaVO, String[] actionRequestedCodes)
| | public ActionRequestVO[] | getActionRequests(Long routeHeaderId)
| | public ActionRequestVO[] | getActionRequests(Long routeHeaderId, String nodeName, UserIdVO userId)
Returns the pending action requests of the document of the specified id for the specified
user and/or the specified node name. | | public ActionTakenVO[] | getActionsTaken(Long routeHeaderId)
| | public RouteNodeInstanceVO[] | getActiveNodeInstances(Long routeHeaderId)
Returns all active node instances on the document. | | public DocumentTypeVO | getDocType(Long documentTypeId)
| | public DocumentTypeVO | getDocType(String documentTypeName)
| | public DocumentContentVO | getDocumentContent(Long routeHeaderId)
| | public DocumentDetailVO | getDocumentDetail(Long documentId)
Returns a document detail VO representing the route header along with action requests, actions taken,
and route node instances. | | public RouteNodeInstanceVO[] | getDocumentRouteNodeInstances(Long routeHeaderId)
Returns the route node instances that have been created so far during the life of the specified document. | | public Long | getNewResponsibilityId()
| | public RouteNodeInstanceVO | getNodeInstance(Long nodeInstanceId)
| | public String[] | getPreviousRouteNodeNames(Long documentId)
| | public RouteTemplateEntryVO[] | getRoute(String documentTypeName)
| | public RouteHeaderVO | getRouteHeader(UserIdVO userId, Long routeHeaderId)
| | public RouteHeaderVO | getRouteHeader(Long documentId)
| | public RouteNodeInstanceVO[] | getTerminalNodeInstances(Long routeHeaderId)
Returns all node instances on the document which have no successor. | | public WorkgroupVO[] | getUserWorkgroups(UserIdVO userId)
Returns an array of workgroups the specified user is in. | | public UserVO | getWorkflowUser(UserIdVO userId)
| | public WorkgroupVO | getWorkgroup(WorkgroupIdVO workgroupId)
| | public WorkgroupVO | getWorkgroup(String workgroupName)
| | public WorkgroupVO | getWorkgroup(Long workgroupId)
| | public boolean | isFinalApprover(Long routeHeaderId, UserIdVO userId)
| | protected boolean | isLastApproverAtNode(Long routeHeaderId, UserIdVO userId, String nodeName)
| | protected boolean | isLastApproverInRouteLevel(Long routeHeaderId, UserIdVO userId, Integer routeLevel)
| | public boolean | isUserAuthenticatedByRouteLog(Long routeHeaderId, UserIdVO userId, boolean lookFuture)
| | public void | reResolveRole(String documentTypeName, String roleName, String qualifiedRoleNameLabel)
Re-resolves the specified role on the document, and refreshes any pending action requests. | | public void | reResolveRole(Long documentId, String roleName, String qualifiedRoleNameLabel)
Re-resolves the specified role on the document, and refreshes any pending action requests. | | protected boolean | routeLevelHasApproverActionRequest(String docType, String docContent, Integer routeLevel)
| | protected boolean | routeNodeHasApproverActionRequest(String docType, String docContent, String nodeName)
| | public DocumentDetailVO | routingReport(ReportCriteriaVO reportCriteria)
| | public RuleVO[] | ruleReport(RuleReportCriteriaVO ruleReportCriteria)
Runs a "rule report" give a rule report criteria. | | public WorkflowAttributeValidationErrorVO[] | validAttributeDefinition(WorkflowAttributeDefinitionVO attributeDefinition)
Validate the WorkflowAttributeDefinition against it's attribute on the server. |
| getActionRequests | | public ActionRequestVO[] getActionRequests(Long routeHeaderId, String nodeName, UserIdVO userId) throws WorkflowException(Code) | | Returns the pending action requests of the document of the specified id for the specified
user and/or the specified node name. If both user and node name are empty then will
return all pending action requests.
Parameters:
routeHeaderId - the id of the document whose action requests will be retrieved
Parameters:
nodeName - the node name of the requests to be retrieved
Parameters:
userId - the user that the requests would be satisfied by the pending action requests of the document of the specified id
throws:
WorkflowException - if an error occurs obtaining the documents action requests
See Also: WorkflowUtility.getActionRequests(Long) |
| getDocumentDetail | | public DocumentDetailVO getDocumentDetail(Long documentId) throws WorkflowException(Code) | | Returns a document detail VO representing the route header along with action requests, actions taken,
and route node instances.
Parameters:
documentId - id of the document whose details should be returned Returns a document detail VO representing the route header along with action requests, actions taken, and route node instances.
throws:
WorkflowException -
See Also: WorkflowUtility.getDocumentDetail(Long) |
| getDocumentRouteNodeInstances | | public RouteNodeInstanceVO[] getDocumentRouteNodeInstances(Long routeHeaderId) throws WorkflowException(Code) | | Returns the route node instances that have been created so far during the life of the specified document. This includes
all previous instances which have already been processed and are no longer active.
Parameters:
routeHeaderId - the id of the document whose route node instances should be returned the route node instances that have been created so far during the life of this document
throws:
WorkflowException - if there is an error getting the route node instances for the document
See Also: WorkflowUtility.getDocumentRouteNodeInstances(Long) |
| isFinalApprover | | public boolean isFinalApprover(Long routeHeaderId, UserIdVO userId) throws WorkflowException(Code) | | Returns whether the specified user is the final approver for the document
Parameters:
routeHeaderId - the id of document to check
Parameters:
userId - the id of the user to check whether the specified user is the final approver for the document
throws:
WorkflowException - if an error occurs determining whether the user is the final approver on the document
See Also: WorkflowUtility.isFinalApprover(LongUserIdVO) |
| isLastApproverAtNode | | protected boolean isLastApproverAtNode(Long routeHeaderId, UserIdVO userId, String nodeName) throws WorkflowException(Code) | | Returns whether the specified user is the last approver at the specified node name
Parameters:
routeHeaderId - the id of document to check
Parameters:
userId - the id of the user to check
Parameters:
nodeName - name of node to check whether the specified user is the last approver at the specified node name
throws:
WorkflowException - if an error occurs determining whether the user is the last approver at the specified node
See Also: WorkflowUtility.isLastApproverAtNode(LongUserIdVOString) |
| isUserAuthenticatedByRouteLog | | public boolean isUserAuthenticatedByRouteLog(Long routeHeaderId, UserIdVO userId, boolean lookFuture) throws WorkflowException(Code) | | Returns whether the user is in the document's route log (whether an action request has been, or may be,
generated for the user)
Parameters:
routeHeaderId - the id of the document to analyze
Parameters:
userId - the id of the user to check
Parameters:
lookFuture - whether to evaluate potential future requests whether the user is in the document's route log
throws:
WorkflowException - if an error occurs determining whether the user is in the document's route log
See Also: WorkflowUtility.isUserInRouteLog(LongUserIdVOboolean) |
| reResolveRole | | public void reResolveRole(String documentTypeName, String roleName, String qualifiedRoleNameLabel) throws WorkflowException(Code) | | Re-resolves the specified role on the document, and refreshes any pending action requests.
Parameters:
documentTypeName - the type of the document for which to re-resolve roles
Parameters:
roleName - the role name to re-resolve
Parameters:
qualifiedRoleNameLabel - the qualified role name label
throws:
WorkflowException - if an error occurs re-resolving the role
See Also: WorkflowUtility.reResolveRole(StringStringString) |
| routeNodeHasApproverActionRequest | | protected boolean routeNodeHasApproverActionRequest(String docType, String docContent, String nodeName) throws WorkflowException(Code) | | Returns whether the specified node on the specified document type would produce approve or complete requests
Parameters:
docType - the type of the document to check
Parameters:
docContent - the content to use
Parameters:
nodeName - the node to check whether the specified node on the specified document type would produce approve or complete requests
throws:
WorkflowException - if an error occurs
See Also: WorkflowUtility.routeNodeHasApproverActionRequest(StringStringString) |
|
|