org.kuali.rice.krms.api.repository.operator

Interface CustomOperator

public interface CustomOperator

A service that can export a custom function as an operator in the KRMS rule editor user interface.

Author:

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

Method Summary

Modifier and Type	Method and Description
FunctionDefinition	getOperatorFunctionDefinition() gets the FunctionDefinition for the function that will be evaluated at rule execution time.
List<RemotableAttributeError>	validateOperandClasses(String lhsClassName, String rhsClassName) Validates that the given operand classes are acceptable for the custom function.

Method Detail

getOperatorFunctionDefinition

FunctionDefinition getOperatorFunctionDefinition()

gets the FunctionDefinition for the function that will be evaluated at rule execution time. Note that the backing FunctionTypeService must be locally available to the application at execution time, as execution objects in KRMS can not be obtained over the service bus. The FunctionDefinition returned by this method must have a return type of java.lang.Boolean, and must have either one or two FunctionParameterDefinitions.

Returns:

a FunctionDefinition with a return type of Boolean

validateOperandClasses

List<RemotableAttributeError> validateOperandClasses(String lhsClassName,
                                                     String rhsClassName)

Validates that the given operand classes are acceptable for the custom function.

Note that the attribute name in returned errors will be ignored.

If only a single operand has been specified, then rhsClassName will be null.

Parameters:

lhsClassName - the class name for the left hand side operand

rhsClassName - the class name for the right hand side operand

Returns:

A list of errors, or an empty list if no errors are found