001/**
002 * Copyright 2005-2016 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;
025
026/**
027 * Defines the contract for a message queue that handles indexing of workflow documents.  The indexing process is
028 * intended to look at the content associated with the workflow document and extra requested attributes for indexing
029 * alongside the document.  These values can then be accessed and/or searched.
030 *
031 * @author Kuali Rice Team (rice.collab@kuali.org)
032 */
033@WebService(name = "documentProcessingQueue", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
034@SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
035public interface DocumentProcessingQueue {
036
037    @WebMethod(operationName = "process")
038    void process(@WebParam(name = "documentId") String documentId) throws RiceIllegalArgumentException;
039
040    @WebMethod(operationName = "processWithOptions")
041    void processWithOptions(@WebParam(name = "documentId") String documentId, @WebParam(name = "options") DocumentProcessingOptions options)
042         throws RiceIllegalArgumentException;
043
044}