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.extension;
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.WebResult;
023    import javax.jws.WebService;
024    import javax.jws.soap.SOAPBinding;
025    import java.util.List;
026    
027    /**
028     * A service which is used for retrieving information about extensions to various
029     * pieces of Kuali Enterprise Workflow.
030     *
031     * @author Kuali Rice Team (rice.collab@kuali.org)
032     */
033    @WebService(name = "extensionRepositoryService", targetNamespace = KewApiConstants.Namespaces.KEW_NAMESPACE_2_0)
034    @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
035    public interface ExtensionRepositoryService {
036        /**
037         * Returns the {@link ExtensionDefinition} of the {@Link RuleAttribute} for the given id.
038         * @param id the id to search by.
039         * @return the extension definition found for the matching rule attribute service
040         * @throws RiceIllegalArgumentException if id is null or blank
041         */
042        @WebMethod(operationName = "getExtensionById")
043        @WebResult(name = "extensionDefinition")
044        ExtensionDefinition getExtensionById(String id) throws RiceIllegalArgumentException;
045    
046        /**
047         * Returns the {@link ExtensionDefinition} of the {@Link RuleAttribute} for the given name.
048         * @param name the name to search by.
049         * @return the extension definition found for the matching rule attribute service
050         * @throws RiceIllegalArgumentException if name is null or blank
051         */
052        @WebMethod(operationName = "getExtensionByName")
053        @WebResult(name = "extensionDefinition")
054        ExtensionDefinition getExtensionByName(String name) throws RiceIllegalArgumentException;
055    
056        /**
057         * Returns the {@link ExtensionDefinition} of the {@Link RuleAttribute} for the given resourceDescriptor.
058         * @param resourceDescriptor the resourceDescriptor to search by.
059         * @return the extension definition found for the matching rule attribute service
060         * @throws RiceIllegalArgumentException if resourceDescriptor is null or blank
061         */
062        @WebMethod(operationName = "getExtensionByResourceDescriptor")
063        @WebResult(name = "extensionDefinitions")
064        List<ExtensionDefinition> getExtensionsByResourceDescriptor(String resourceDescriptor) throws RiceIllegalArgumentException;
065    
066    }