com.crystaldecisions.reports.formulas
Interface FormulaFunctionLibrary

public interface FormulaFunctionLibrary

Provides the main interface that must be implemented for the user defined library. User-defined functions are organized into collections called User-defined Function Libraries. Each User-defined Function Library must implement the FormulaFunctionLibrary interface, which provides methods for retrieving the functions in the library. All of the methods in this interface must be implemented.

Method Summary

FormulaFunction	getFunction(int functionNumber) Gets an instance of a function (FormulaFunction) in the library.
int	size() Gets the number of functions in the library (the number of FormulaFunction instances that the library provides).

Method Detail

size

public int size()

Gets the number of functions in the library (the number of FormulaFunction instances that the library provides).

Returns:

the number of functions in the library

getFunction

public FormulaFunction getFunction(int functionNumber)

Gets an instance of a function (FormulaFunction) in the library. The FormulaFunction instance returned corresponds to the functionNumber taken in by the getFunction method. The instances returned should be different for each different functionNumber, however, instances returned for the same functionNumber may either be the same or different.

Parameters:

functionNumber - an int that corresponds to a function in the library

Returns:

an instance of the function as a FormulaFunction object