View Javadoc

1   /**
2    * Copyright 2005-2014 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.action;
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 of a message queue for "poking" a role for a specified document.  When a role is "poked" it will
28   * attempt to re-resolve the members of a role and update action requests as appropriate.
29   * 
30   * @author Kuali Rice Team (rice.collab@kuali.org)
31   */
32  @WebService(name = "rolePokerQueue", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
33  @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
34  public interface RolePokerQueue {
35  
36      @WebMethod(operationName = "reResolveRole")
37      void reResolveRole(
38              @WebParam(name = "documentId") String documentId,
39              @WebParam(name = "roleName") String roleName
40      ) throws RiceIllegalArgumentException;
41  
42      @WebMethod(operationName = "reResolveQualifiedRole")
43  	void reResolveQualifiedRole(
44              @WebParam(name = "documentId") String documentId,
45              @WebParam(name = "roleName") String roleName,
46              @WebParam(name = "qualifiedRoleNameLabel") String qualifiedRoleNameLabel
47      ) throws RiceIllegalArgumentException;
48      
49  
50  
51  }