package org.kuali.rice.krms.api.repository.function;

 import java.util.List;

 import javax.jws.WebMethod;

 import javax.jws.WebParam;

 import javax.jws.WebResult;

 import javax.jws.WebService;

 import javax.jws.soap.SOAPBinding;

 import org.kuali.rice.krms.api.repository.RepositoryConstants;

 /**

  * The function repository contains information about custom functions which

  * can be used on propositions that are defined when constructing rules.

  * 

  * @author Kuali Rice Team (rice.collab@kuali.org)

  *

  */

 @WebService(name = "functionRepositoryService", targetNamespace = RepositoryConstants.Namespaces.REPOSITORY_NAMESPACE_2_0)

 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)

 public interface FunctionRepositoryService {

         /**

          * Retrieves the function for the given functionId.  The function can be used when

          * constructing propositions and defines the type of the parameters to the function

          * as well as it's return type.

          * 

          * @param functionId the id of the function to retrieve

          * @return the function definition, or null if no function could be located for the given functionId

          * 

          * @throws IllegalArgumentException if the given functionId is null

          */

         @WebMethod(operationName = "getFunction")

         @WebResult(name = "function")

         public FunctionDefinition getFunction(@WebParam(name = "functionId") String functionId);

         /**

          * Retrieves all of the functions for the given list of functionIds.  The

          * function can be used when constructing propositions and defines the type

          * of the parameters to the function as well as it's return type.

          * 

          * <p>The list which is returned from this operation may not be the same size as the list

          * which is passed to this method.  If a function doesn't exist for a given function id then

          * no result for that id will be returned in the list.  As a result of this, the returned

          * list can be empty, but it will never be null.

          * 

          * @param functionIds the list of function ids for which to retrieve the functions

          * @return the list of functions for the given ids, this list will only contain functions for the ids

          * that were resolved successfully, it will never return null but could return an empty list if no

          * functions could be loaded for the given set of ids

          * 

          * @throws IllegalArgumentException if the given list of functionIds is null

          */

         @WebMethod(operationName = "getFunctions")

         @WebResult(name = "functions")

         public List<FunctionDefinition> getFunctions(@WebParam(name = "functionIds") List<String> functionIds);

 }