com.businessobjects.rebean.wi
Interface Function

public interface Function

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

The Function interface holds information about Web Intelligence functions.

Since:

11.5

Method Summary

FunctionCategory[]	getCategories() Returns the list of FunctionCategory to which this function belongs.
java.lang.String	getHint() Returns the hint about the function.
int	getID() Returns the Function ID.
java.lang.String	getName() Returns the localized name of the Function.
java.lang.String	getReturnType() Returns this Function objects return type name.
java.lang.String	getSyntax() Returns the syntax of the Function.

Method Detail

getID

int getID()

Returns the Function ID.

Returns:

The Id of the Function.

See Also:

AllAvailableFunctionsIdentifiers

getName

java.lang.String getName()

Returns the localized name of the Function.

Returns:

The Function name.

getHint

java.lang.String getHint()

Returns the hint about the function.

Returns:

the function hint.

getSyntax

java.lang.String getSyntax()

Returns the syntax of the Function.

Returns:

The Function syntax.

getReturnType

java.lang.String getReturnType()

Returns this Function objects return type name.

Possible return type names are:

• Number
• Integer
• Any
• Date
• Time
• String
• Variable
• Boolean

Returns:

This Function objects return type name.

getCategories

FunctionCategory[] getCategories()

Returns the list of FunctionCategory to which this function belongs.

Examples of possible categories are:

• All
• Aggregate
• Character
• Date and Time

Returns:

a Array of FunctionCategory objects.