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