Coverage Report - org.kuali.rice.kew.service.WorkflowDocumentActions
 
Classes in this File Line Coverage Branch Coverage Complexity
WorkflowDocumentActions
N/A
N/A
N/A
N/A
1
 
 1   
 /*
 2   
  * Copyright 2005-2007 The Kuali Foundation
 3   
  *
 4   
  *
 5   
  * Licensed under the Educational Community License, Version 2.0 (the "License");
 6   
  * you may not use this file except in compliance with the License.
 7   
  * You may obtain a copy of the License at
 8   
  *
 9   
  * http://www.opensource.org/licenses/ecl2.php
 10   
  *
 11   
  * Unless required by applicable law or agreed to in writing, software
 12   
  * distributed under the License is distributed on an "AS IS" BASIS,
 13   
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14   
  * See the License for the specific language governing permissions and
 15   
  * limitations under the License.
 16   
  */
 17   
 package org.kuali.rice.kew.service;
 18   
 
 19   
 import org.kuali.rice.kew.dto.AdHocRevokeDTO;
 20   
 import org.kuali.rice.kew.dto.DocumentContentDTO;
 21   
 import org.kuali.rice.kew.dto.MovePointDTO;
 22   
 import org.kuali.rice.kew.dto.ReturnPointDTO;
 23   
 import org.kuali.rice.kew.dto.RouteHeaderDTO;
 24   
 import org.kuali.rice.kew.exception.WorkflowException;
 25   
 
 26   
 /**
 27   
  * A remotable service which provides an API for actions on documents.
 28   
  *
 29   
  * @author Kuali Rice Team (rice.collab@kuali.org)
 30   
  */
 31   
 public interface WorkflowDocumentActions {
 32   
 
 33   
     public RouteHeaderDTO acknowledgeDocument(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 34   
     public RouteHeaderDTO approveDocument(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 35   
     public RouteHeaderDTO adHocRouteDocumentToPrincipal(String principalId, RouteHeaderDTO routeHeader, String actionRequested, String nodeName, String annotation, String targetPrincipalId, String responsibilityDesc, boolean forceAction, String requestLabel) throws WorkflowException;
 36   
     public RouteHeaderDTO adHocRouteDocumentToGroup(String principalId, RouteHeaderDTO routeHeader, String actionRequested, String nodeName, String annotation, String groupId, String responsibilityDesc, boolean forceAction, String requestLabel) throws WorkflowException;
 37   
     public RouteHeaderDTO cancelDocument(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 38   
     public RouteHeaderDTO clearFYIDocument(String principalId, RouteHeaderDTO routeHeader) throws WorkflowException;
 39   
     public RouteHeaderDTO completeDocument(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 40   
     public RouteHeaderDTO createDocument(String principalId, RouteHeaderDTO routeHeader) throws WorkflowException;
 41   
     public RouteHeaderDTO disapproveDocument(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 42   
 
 43   
     public RouteHeaderDTO routeDocument(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 44   
     public RouteHeaderDTO saveRoutingData(String principalId, RouteHeaderDTO routeHeader) throws WorkflowException;
 45   
     public RouteHeaderDTO saveDocument(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 46   
     public void deleteDocument(String principalId, RouteHeaderDTO routeHeader) throws WorkflowException;
 47   
     public void logDocumentAction(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 48   
     public RouteHeaderDTO superUserApprove(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 49   
     public RouteHeaderDTO superUserActionRequestApprove(String principalId, RouteHeaderDTO routeHeaderVO, Long actionRequestId, String annotation) throws WorkflowException;
 50   
     public RouteHeaderDTO superUserDisapprove(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 51   
     public RouteHeaderDTO superUserCancel(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 52   
 
 53   
     public DocumentContentDTO saveDocumentContent(DocumentContentDTO documentContent) throws WorkflowException;
 54   
 
 55   
     public RouteHeaderDTO placeInExceptionRouting(String principalId, RouteHeaderDTO routeHeader, String annotation) throws WorkflowException;
 56   
 
 57   
     // Deprecated as of 2.1 //
 58   
 
 59   
     /**
 60   
      * @deprecated use blanketApproveToNodes instead
 61   
      */
 62   
     public RouteHeaderDTO blanketApproval(String principalId, RouteHeaderDTO routeHeader, String annotation, Integer routeLevel) throws WorkflowException;
 63   
 
 64   
     /**
 65   
      * @deprecated use returnDocumentToPreviousNode instead
 66   
      */
 67   
     public RouteHeaderDTO returnDocumentToPreviousRouteLevel(String principalId, RouteHeaderDTO routeHeader, Integer destRouteLevel, String annotation) throws WorkflowException;
 68   
 
 69   
     // Introduced in 2.1 //
 70   
 
 71   
     public RouteHeaderDTO blanketApprovalToNodes(String principalId, RouteHeaderDTO routeHeader, String annotation, String[] nodeNames) throws WorkflowException;
 72   
     public RouteHeaderDTO returnDocumentToPreviousNode(String principalId, RouteHeaderDTO routeHeader, ReturnPointDTO returnPoint, String annotation) throws WorkflowException;
 73   
     public RouteHeaderDTO takeGroupAuthority(String principalId, RouteHeaderDTO routeHeader, String groupId, String annotation) throws WorkflowException;
 74   
     public RouteHeaderDTO releaseGroupAuthority(String principalId, RouteHeaderDTO routeHeader, String groupId, String annotation) throws WorkflowException;
 75   
     public RouteHeaderDTO moveDocument(String principalId, RouteHeaderDTO routeHeader, MovePointDTO movePoint, String annotation) throws WorkflowException;
 76   
 
 77   
     // Introduced in 2.2.2 //
 78   
 
 79   
     /**
 80   
      * Revokes AdHoc request(s) according to the given AppSpecificRevokeVO which is passed in.
 81   
      */
 82   
     public RouteHeaderDTO revokeAdHocRequests(String principalId, RouteHeaderDTO routeHeader, AdHocRevokeDTO revoke, String annotation) throws WorkflowException;
 83   
 
 84   
     /**
 85   
      * @since 0.9.1.3
 86   
      */
 87   
     public void superUserNodeApproveAction(String principalId, String documentId, String nodeName, String annotation) throws WorkflowException;
 88   
 
 89   
     /**
 90   
      * @since 0.9.1.3
 91   
      */
 92   
     public void superUserReturnToPreviousNode(String principalId, String documentId, String destinationNodeName, String annotation) throws WorkflowException;
 93   
 
 94   
     /**
 95   
      * @since 0.9.1.3
 96   
      */
 97   
     public void superUserActionRequestApproveAction(String principalId, String documentId, Long actionRequestId, String annotation) throws WorkflowException;
 98   
 
 99   
     /**
 100   
      * @since 0.9.3
 101   
      */
 102   
     public void superUserNodeApproveAction(String principalId, String documentId, String nodeName, String annotation, boolean runPostProcessor) throws WorkflowException;
 103   
 
 104   
     /**
 105   
      * @since 0.9.3
 106   
      */
 107   
     public RouteHeaderDTO superUserApprove(String principalId, RouteHeaderDTO routeHeader, String annotation, boolean runPostProcessor) throws WorkflowException;
 108   
 
 109   
     /**
 110   
      * @since 0.9.3
 111   
      */
 112   
     public RouteHeaderDTO superUserDisapprove(String principalId, RouteHeaderDTO routeHeader, String annotation, boolean runPostProcessor) throws WorkflowException;
 113   
 
 114   
     /**
 115   
      * @since 0.9.3
 116   
      */
 117   
     public RouteHeaderDTO superUserCancel(String principalId, RouteHeaderDTO routeHeader, String annotation, boolean runPostProcessor) throws WorkflowException;
 118   
 
 119   
     /**
 120   
      * @since 0.9.3
 121   
      */
 122   
     public void superUserReturnToPreviousNode(String principalId, String documentId, String destinationNodeName, String annotation, boolean runPostProcessor) throws WorkflowException;
 123   
 
 124   
     /**
 125   
      * @since 0.9.3
 126   
      */
 127   
     public void superUserActionRequestApproveAction(String principalId, String documentId, Long actionRequestId, String annotation, boolean runPostProcessor) throws WorkflowException;
 128   
 
 129   
     /**
 130   
      *
 131   
      * This method This mehtod indexes a document based on the documentId.
 132   
      *
 133   
      * @param documentId
 134   
      */
 135   
     public void indexDocument(String documentId);
 136   
 
 137   
 }
Report generated by Cobertura 1.9.4.1 on 7/7/11 4:13 AM.