com.crystaldecisions.reports.formulas
Interface FormulaFunctionDefinition

All Known Subinterfaces:
FormulaFunction

public interface FormulaFunctionDefinition

Provides information about a given FormulaFunction implementation. This interface must be implemented for each function in the user defined function library. All of the methods in this interface must be implemented.


Method Summary
 FormulaFunctionArgumentDefinition[] getArguments()
           Gets the arguments that are defined for this function.
 java.lang.String getIdentifier()
           Gets the String used to identify this function in a function call (or in Crystal Reports).
 FormulaValueType getReturnType()
           Gets the type of the FormulaValue returned by the user defined function.
 

Method Detail

getReturnType

FormulaValueType getReturnType()

Gets the type of the FormulaValue returned by the user defined function.

Returns:
the type of the FormulaValue returned by the user defined function.

getIdentifier

java.lang.String getIdentifier()

Gets the String used to identify this function in a function call (or in Crystal Reports). The identifier must begin with a lower case letter and may only contain lower case letters, digits and underscores.
Note: The identifier cannot be a reserved name in any syntax where the function is defined.

Returns:
the String used to identify this function in a function call

getArguments

FormulaFunctionArgumentDefinition[] getArguments()

Gets the arguments that are defined for this function. If this user defined function has zero arguments, a zero-length array is returned.

Returns:
the arguments defined for this function