Coverage Report - org.kuali.rice.kew.api.document.DocumentProcessingQueue
 
Classes in this File Line Coverage Branch Coverage Complexity
DocumentProcessingQueue
N/A
N/A
1
 
 1  
 /**
 2  
  * Copyright 2005-2011 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  
 
 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 = "documentProcessingQueue", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
 34  
 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
 35  
 public interface DocumentProcessingQueue {
 36  
 
 37  
     @WebMethod(operationName = "process")
 38  
     void process(@WebParam(name = "documentId") String documentId) throws RiceIllegalArgumentException;
 39  
 
 40  
     @WebMethod(operationName = "processWithOptions")
 41  
     void processWithOptions(@WebParam(name = "documentId") String documentId, @WebParam(name = "options") DocumentProcessingOptions options)
 42  
          throws RiceIllegalArgumentException;
 43  
 
 44  
 }