Package org.kuali.rice.kew.routeheader.service

Interface WorkflowDocumentService

All Known Implementing Classes:
WorkflowDocumentServiceImpl
public interface WorkflowDocumentService
Service for initiating actions against documents. Uses from the service endpoint for the client API.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Method Details

    • acknowledgeDocument

      DocumentRouteHeaderValue acknowledgeDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • approveDocument

      DocumentRouteHeaderValue approveDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • adHocRouteDocumentToPrincipal

      DocumentRouteHeaderValue adHocRouteDocumentToPrincipal(String principalId, DocumentRouteHeaderValue routeHeader, String actionRequested, String routeMethodName, Integer priority, String annotation, String targetPrincipalId, String responsibilityDesc, Boolean forceAction, String requestLabel) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • adHocRouteDocumentToGroup

      DocumentRouteHeaderValue adHocRouteDocumentToGroup(String principalId, DocumentRouteHeaderValue routeHeader, String actionRequested, String routeMethodName, Integer priority, String annotation, String groupId, String responsibilityDesc, Boolean forceAction, String requestLabel) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • cancelDocument

      DocumentRouteHeaderValue cancelDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • clearFYIDocument

      DocumentRouteHeaderValue clearFYIDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • completeDocument

      DocumentRouteHeaderValue completeDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • createDocument

      DocumentRouteHeaderValue createDocument(String principalId, DocumentRouteHeaderValue routeHeader) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • disapproveDocument

      DocumentRouteHeaderValue disapproveDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • routeDocument

      DocumentRouteHeaderValue routeDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.WorkflowException, org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • saveRoutingData

      DocumentRouteHeaderValue saveRoutingData(String principalId, DocumentRouteHeaderValue routeHeader)

    • saveDocument

      DocumentRouteHeaderValue saveDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • deleteDocument

      void deleteDocument(String principalId, DocumentRouteHeaderValue routeHeader) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • logDocumentAction

      void logDocumentAction(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • superUserActionRequestApproveAction

      DocumentRouteHeaderValue superUserActionRequestApproveAction(String principalId, DocumentRouteHeaderValue routeHeader, String actionRequestId, String annotation, boolean runPostProcessor) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • superUserActionRequestApproveAction

      DocumentRouteHeaderValue superUserActionRequestApproveAction(String principalId, String documentId, String actionRequestId, String annotation, boolean runPostProcessor) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • superUserApprove

      DocumentRouteHeaderValue superUserApprove(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, boolean runPostProcessor) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • superUserCancelAction

      DocumentRouteHeaderValue superUserCancelAction(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, boolean runPostProcessor) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • superUserDisapproveAction

      DocumentRouteHeaderValue superUserDisapproveAction(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, boolean runPostProcessor) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • placeInExceptionRouting

      DocumentRouteHeaderValue placeInExceptionRouting(String principalId, DocumentRouteHeaderValue routeHeader, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • blanketApproval

      DocumentRouteHeaderValue blanketApproval(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, Set nodeNames) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.1

    • returnDocumentToPreviousNode

      DocumentRouteHeaderValue returnDocumentToPreviousNode(String principalId, DocumentRouteHeaderValue routeHeader, String destinationNodeName, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.1

    • superUserReturnDocumentToPreviousNode

      DocumentRouteHeaderValue superUserReturnDocumentToPreviousNode(String principalId, DocumentRouteHeaderValue routeHeader, String nodeName, String annotation, boolean runPostProcessor) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.1

    • takeGroupAuthority

      DocumentRouteHeaderValue takeGroupAuthority(String principalId, DocumentRouteHeaderValue routeHeader, String groupId, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.1

    • releaseGroupAuthority

      DocumentRouteHeaderValue releaseGroupAuthority(String principalId, DocumentRouteHeaderValue routeHeader, String groupId, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.1

    • superUserNodeApproveAction

      DocumentRouteHeaderValue superUserNodeApproveAction(String principalId, DocumentRouteHeaderValue routeHeader, String nodeName, String annotation, boolean runPostProcessor) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.1

    • moveDocument

      DocumentRouteHeaderValue moveDocument(String principalId, DocumentRouteHeaderValue routeHeader, org.kuali.rice.kew.api.action.MovePoint movePoint, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.1

    • recallDocument

      DocumentRouteHeaderValue recallDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, boolean cancel) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      TODO: docs
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.1

    • takeMassActions

      void takeMassActions(String principalId, List<org.kuali.rice.kew.api.action.ActionInvocation> actionInvocations)
      Invokes a List of actions at once. This method will remove the approriate action items from the user's action list and then schedule the actual processing of the actions.
      Since:
      2.2

    • superUserReturnDocumentToPreviousNode

      DocumentRouteHeaderValue superUserReturnDocumentToPreviousNode(String principalId, String documentId, String nodeName, String annotation, boolean runPostProcessor) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.2

    • superUserNodeApproveAction

      DocumentRouteHeaderValue superUserNodeApproveAction(String principalId, String documentId, String nodeName, String annotation, boolean runPostProcessor) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.2.7

    • revokeAdHocRequests

      DocumentRouteHeaderValue revokeAdHocRequests(String principalId, DocumentRouteHeaderValue document, org.kuali.rice.kew.api.action.AdHocRevoke revoke, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Since:
      2.2.2

    • revokeAdHocRequests

      DocumentRouteHeaderValue revokeAdHocRequests(String principalId, DocumentRouteHeaderValue document, String actionRequestId, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • blanketApproval

      @Deprecated DocumentRouteHeaderValue blanketApproval(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, Integer routeLevel) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Deprecated.
      use blanketApproval which takes a Set of nodeNames instead.
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException

    • returnDocumentToPreviousRouteLevel

      @Deprecated DocumentRouteHeaderValue returnDocumentToPreviousRouteLevel(String principalId, DocumentRouteHeaderValue routeHeader, Integer destRouteLevel, String annotation) throws org.kuali.rice.kew.api.exception.InvalidActionTakenException
      Deprecated.
      use returnDocumentToPreviousNode instead
      Throws:
      org.kuali.rice.kew.api.exception.InvalidActionTakenException