FunctionRepositoryService

Name FunctionRepository
Version
Included Services  
Java Package org.kuali.rice.krms.api.repository.function

The function repository contains information about custom functions which
can be used on propositions that are defined when constructing rules.

Operations
Main Message Structures

Method getFunction
Description 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.
Parameters String functionId the id of the function to retrieve
Return FunctionDefinition the function definition, or null if no function could be located for the given functionId
Errors RiceIllegalArgumentException if the given functionId is null

Back to Operations

Method getFunctions
Description 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.

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.

Parameters StringList functionIds the list of function ids for which to retrieve the functions
Return FunctionDefinitionList 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
Errors RiceIllegalArgumentException if the given list of functionIds is null

Back to Operations