Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright 2005-2013 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.opensource.org/licenses/ecl2.php Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
 package org.kuali.rice.kew.routeheader.service;
 
 import java.util.List;
 import java.util.Set;
 
Service for initiating actions against documents. Uses from the service endpoint for the client API.

 
 public interface WorkflowDocumentService {
 
     public DocumentRouteHeaderValue acknowledgeDocument(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows InvalidActionTakenException;
     public DocumentRouteHeaderValue approveDocument(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows InvalidActionTakenException;
     public DocumentRouteHeaderValue adHocRouteDocumentToPrincipal(String principalIdDocumentRouteHeaderValue routeHeaderString actionRequestedString routeMethodNameInteger priorityString annotationString targetPrincipalIdString responsibilityDescBoolean forceActionString requestLabelthrows WorkflowException;
     public DocumentRouteHeaderValue adHocRouteDocumentToGroup(String principalIdDocumentRouteHeaderValue routeHeaderString actionRequestedString routeMethodNameInteger priorityString annotationString groupIdString responsibilityDescBoolean forceActionString requestLabelthrows WorkflowException;
     public DocumentRouteHeaderValue cancelDocument(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows InvalidActionTakenException;
     public DocumentRouteHeaderValue clearFYIDocument(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows InvalidActionTakenException;
     public DocumentRouteHeaderValue completeDocument(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows InvalidActionTakenException;
     public DocumentRouteHeaderValue createDocument(String principalIdDocumentRouteHeaderValue routeHeaderthrows WorkflowException;
     public DocumentRouteHeaderValue disapproveDocument(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows InvalidActionTakenException;
 
     public DocumentRouteHeaderValue routeDocument(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows WorkflowExceptionInvalidActionTakenException;
     public DocumentRouteHeaderValue saveRoutingData(String principalIdDocumentRouteHeaderValue routeHeader);
     public DocumentRouteHeaderValue saveDocument(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows InvalidActionTakenException;
     public void deleteDocument(String principalIdDocumentRouteHeaderValue routeHeaderthrows WorkflowException;
     public void logDocumentAction(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows InvalidActionTakenException;
 
     public DocumentRouteHeaderValue superUserActionRequestApproveAction(String principalIdDocumentRouteHeaderValue routeHeaderString actionRequestIdString annotationboolean runPostProcessorthrows InvalidActionTakenException;
     public DocumentRouteHeaderValue superUserActionRequestApproveAction(String principalIdString documentIdString actionRequestIdString annotationboolean runPostProcessorthrows InvalidActionTakenException;
     public DocumentRouteHeaderValue superUserApprove(String principalIdDocumentRouteHeaderValue routeHeaderString annotationboolean runPostProcessorthrows InvalidActionTakenException;
     public DocumentRouteHeaderValue superUserCancelAction(String principalIdDocumentRouteHeaderValue routeHeaderString annotationboolean runPostProcessorthrows InvalidActionTakenException;
     public DocumentRouteHeaderValue superUserDisapproveAction(String principalIdDocumentRouteHeaderValue routeHeaderString annotationboolean runPostProcessorthrows InvalidActionTakenException;
 
     public DocumentRouteHeaderValue placeInExceptionRouting(String principalIdDocumentRouteHeaderValue routeHeaderString annotationthrows InvalidActionTakenException;
     
     // Introduced in 2.1 //
 
    

Since:
2.1
 
     public DocumentRouteHeaderValue blanketApproval(String principalIdDocumentRouteHeaderValue routeHeaderString annotationSet nodeNamesthrows InvalidActionTakenException;

    

Since:
2.1
 
     public DocumentRouteHeaderValue returnDocumentToPreviousNode(String principalIdDocumentRouteHeaderValue routeHeaderString destinationNodeNameString annotationthrows InvalidActionTakenException;

    

Since:
2.1
 
     public DocumentRouteHeaderValue superUserReturnDocumentToPreviousNode(String principalIdDocumentRouteHeaderValue routeHeaderString nodeNameString annotationboolean runPostProcessorthrows InvalidActionTakenException;

    

Since:
2.1
 
     public DocumentRouteHeaderValue takeGroupAuthority(String principalIdDocumentRouteHeaderValue routeHeaderString groupIdString annotationthrows InvalidActionTakenException;

    

Since:
2.1
 
     public DocumentRouteHeaderValue releaseGroupAuthority(String principalIdDocumentRouteHeaderValue routeHeaderString groupIdString annotationthrows InvalidActionTakenException;

    

Since:
2.1
 
     public DocumentRouteHeaderValue superUserNodeApproveAction(String principalIdDocumentRouteHeaderValue routeHeaderString nodeNameString annotationboolean runPostProcessorthrows InvalidActionTakenException;

    

Since:
2.1
    public DocumentRouteHeaderValue moveDocument(String principalIdDocumentRouteHeaderValue routeHeaderMovePoint movePointString annotationthrows InvalidActionTakenException;

    
TODO: docs

Since:
2.1
    public DocumentRouteHeaderValue recallDocument(String principalIdDocumentRouteHeaderValue routeHeaderString annotationboolean cancelthrows InvalidActionTakenException;
    // Introduced in 2.2

    
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
    public void takeMassActions(String principalIdList<ActionInvocationactionInvocations);

    

Since:
2.2
    public DocumentRouteHeaderValue superUserReturnDocumentToPreviousNode(String principalIdString documentIdString nodeNameString annotationboolean runPostProcessorthrows InvalidActionTakenException;

    

Since:
2.2.7
    public DocumentRouteHeaderValue superUserNodeApproveAction(String principalIdString documentIdString nodeNameString annotationboolean runPostProcessorthrows InvalidActionTakenException;
    // Introduced in 2.2.2

    

Since:
2.2.2
    public DocumentRouteHeaderValue revokeAdHocRequests(String principalIdDocumentRouteHeaderValue documentAdHocRevoke revokeString annotationthrows InvalidActionTakenException;
    
    public DocumentRouteHeaderValue revokeAdHocRequests(String principalIdDocumentRouteHeaderValue documentString actionRequestIdString annotationthrows InvalidActionTakenException;
    // Deprecated as of 2.1 //

    

Deprecated:
use blanketApproval which takes a Set of nodeNames instead.
    public DocumentRouteHeaderValue blanketApproval(String principalIdDocumentRouteHeaderValue routeHeaderString annotationInteger routeLevelthrows InvalidActionTakenException;

    

Deprecated:
use returnDocumentToPreviousNode instead
    public DocumentRouteHeaderValue returnDocumentToPreviousRouteLevel(String principalIdDocumentRouteHeaderValue routeHeaderInteger destRouteLevelString annotationthrows InvalidActionTakenException;
New to GrepCode? Check out our FAQ X