1 /** 2 * Copyright 2005-2014 The Kuali Foundation 3 * 4 * Licensed under the Educational Community License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.opensource.org/licenses/ecl2.php 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package org.kuali.rice.kew.api.document; 17 18 import org.kuali.rice.core.api.exception.RiceIllegalArgumentException; 19 import org.kuali.rice.kew.api.KewApiConstants; 20 21 import javax.jws.WebMethod; 22 import javax.jws.WebParam; 23 import javax.jws.WebService; 24 import javax.jws.soap.SOAPBinding; 25 import java.util.Set; 26 27 /** 28 * Defines the contract for a message queue which handles orchestrating documents through the blanket approval process. 29 * 30 * @author Kuali Rice Team (rice.collab@kuali.org) 31 */ 32 @WebService(name = "documentOrchestrationQueue", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0) 33 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED) 34 public interface DocumentOrchestrationQueue { 35 36 /** 37 * Orchestrates the document with the given id through the blanket approval process to the specified list of node 38 * names. If the node names are empty, then the document will be orchestrated all the way to the end of its 39 * workflow process. 40 * 41 * <p>This orchestration can also optional index search attributes after orchestration has complete if the value 42 * for {@code shouldSearchIndex} is "true".</p> 43 * 44 * @param documentId the id of the document to orchestrate through the blanket approval process 45 * @param principalId the id of the principal who initiated the blanket approval 46 * @param orchestrationConfig contains configuration for how the orchestration should be performed 47 * 48 * @throws RiceIllegalArgumentException if documentId is a null or blank value 49 * @throws RiceIllegalArgumentException if principalId is a null or blank value 50 * @throws RiceIllegalArgumentException if orchestrationConfig is null 51 */ 52 @WebMethod(operationName = "orchestrateDocument") 53 void orchestrateDocument( 54 @WebParam(name = "documentId") String documentId, 55 @WebParam(name = "principalId") String principalId, 56 @WebParam(name = "orchestrationConfig") OrchestrationConfig orchestrationConfig, 57 @WebParam(name = "documentProcessingOptions") DocumentProcessingOptions documentProcessingOptions 58 ) throws RiceIllegalArgumentException; 59 60 }