001/**
002 * Copyright 2005-2014 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.api.document;
017
018import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
019import org.kuali.rice.kew.api.KewApiConstants;
020
021import javax.jws.WebMethod;
022import javax.jws.WebParam;
023import javax.jws.WebService;
024import javax.jws.soap.SOAPBinding;
025import java.util.Set;
026
027/**
028 * Defines the contract for a message queue which handles orchestrating documents through the blanket approval process.
029 *
030 * @author Kuali Rice Team (rice.collab@kuali.org)
031 */
032@WebService(name = "documentOrchestrationQueue", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
033@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
034public interface DocumentOrchestrationQueue {
035
036    /**
037     * Orchestrates the document with the given id through the blanket approval process to the specified list of node
038     * names.  If the node names are empty, then the document will be orchestrated all the way to the end of its
039     * workflow process.
040     *
041     * <p>This orchestration can also optional index search attributes after orchestration has complete if the value
042     * for {@code shouldSearchIndex} is "true".</p>
043     *
044     * @param documentId the id of the document to orchestrate through the blanket approval process
045     * @param principalId the id of the principal who initiated the blanket approval
046     * @param orchestrationConfig contains configuration for how the orchestration should be performed
047     *
048     * @throws RiceIllegalArgumentException if documentId is a null or blank value
049     * @throws RiceIllegalArgumentException if principalId is a null or blank value
050     * @throws RiceIllegalArgumentException if orchestrationConfig is null
051     */
052    @WebMethod(operationName = "orchestrateDocument")
053        void orchestrateDocument(
054            @WebParam(name = "documentId") String documentId,
055            @WebParam(name = "principalId") String principalId,
056            @WebParam(name = "orchestrationConfig") OrchestrationConfig orchestrationConfig,
057            @WebParam(name = "documentProcessingOptions") DocumentProcessingOptions documentProcessingOptions
058    ) throws RiceIllegalArgumentException;
059
060}