View Javadoc
1   /**
2    * Copyright 2005-2015 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.attribute;
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  
26  /**
27   * Defines the contract for a message queue that handles indexing of workflow documents.  The indexing process is
28   * intended to look at the content associated with the workflow document and extra requested attributes for indexing
29   * alongside the document.  These values can then be accessed and/or searched.
30   *
31   * @author Kuali Rice Team (rice.collab@kuali.org)
32   */
33  @WebService(name = "documentAttributeIndexingQueue", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
34  @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
35  public interface DocumentAttributeIndexingQueue {
36  
37      /**
38       * Perform document attribute indexing on the document with the given id.  The given document id must be valid,
39       * otherwise a {@code RiceIllegalArgumentException} will be thrown.
40       *
41       * @param documentId the id of the document to index, cannot be a null or blank value and must be an accurate
42       * identifier for an existing document
43       *
44       * @throws RiceIllegalArgumentException if the given document id is a null or blank value, or if it does not
45       * resolve to a valid document
46       */
47      @WebMethod(operationName = "indexDocument")
48  	void indexDocument(@WebParam(name = "documentId") String documentId) throws RiceIllegalArgumentException;
49  
50  }