001    /**
002     * Copyright 2005-2014 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.action;
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 of a message queue for "poking" a role for a specified document.  When a role is "poked" it will
028     * attempt to re-resolve the members of a role and update action requests as appropriate.
029     * 
030     * @author Kuali Rice Team (rice.collab@kuali.org)
031     */
032    @WebService(name = "rolePokerQueue", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
033    @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
034    public interface RolePokerQueue {
035    
036        @WebMethod(operationName = "reResolveRole")
037        void reResolveRole(
038                @WebParam(name = "documentId") String documentId,
039                @WebParam(name = "roleName") String roleName
040        ) throws RiceIllegalArgumentException;
041    
042        @WebMethod(operationName = "reResolveQualifiedRole")
043            void reResolveQualifiedRole(
044                @WebParam(name = "documentId") String documentId,
045                @WebParam(name = "roleName") String roleName,
046                @WebParam(name = "qualifiedRoleNameLabel") String qualifiedRoleNameLabel
047        ) throws RiceIllegalArgumentException;
048        
049    
050    
051    }