001    /**
002     * Copyright 2005-2012 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     */
016    package org.kuali.rice.kew.api.document.attribute;
017    
018    import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
019    import org.kuali.rice.kew.api.KewApiConstants;
020    
021    import javax.jws.WebMethod;
022    import javax.jws.WebParam;
023    import javax.jws.WebService;
024    import 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 = "documentAttributeIndexingQueue", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
034    @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
035    public interface DocumentAttributeIndexingQueue {
036    
037        /**
038         * Perform document attribute indexing on the document with the given id.  The given document id must be valid,
039         * otherwise a {@code RiceIllegalArgumentException} will be thrown.
040         *
041         * @param documentId the id of the document to index, cannot be a null or blank value and must be an accurate
042         * identifier for an existing document
043         *
044         * @throws RiceIllegalArgumentException if the given document id is a null or blank value, or if it does not
045         * resolve to a valid document
046         */
047        @WebMethod(operationName = "indexDocument")
048            void indexDocument(@WebParam(name = "documentId") String documentId) throws RiceIllegalArgumentException;
049    
050    }