com.tibco.xp.studio.annotation

Annotation Type Function

@Documented
 @Retention(value=CLASS)
 @Target(value=METHOD)
public @interface Function

Expose a static method as a catalog function

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	asynchronous Function executes asynchronously
java.lang.String	cautions Description of any cautions associated with this function.
boolean	disableOptimization Disable optimization of rule function
java.lang.String	example Example on how to use this function.
boolean	hasSideEffects Indicate whether method has side-effects.

Element Detail

hasSideEffects

public abstract boolean hasSideEffects

Indicate whether method has side-effects.

A method has side effects if it modifies application concepts.

The default value is true.

Returns:

True if method has side-effects. False if method has no side-effects.

Default:

true

disableOptimization

public abstract boolean disableOptimization

Disable optimization of rule function

Setting this value to true indicates that the result of this function cannot be cached to optimize performance - it must always be evaluated.

Setting this value to false indicates that the result of this function can be cached to optimize performance. In some cases, this function will be skipped being called during rule execution.

The default value is true.

Returns:

True to disable optimization, false to enable optimization.

Default:

true

asynchronous

public abstract boolean asynchronous

Function executes asynchronously

Setting this value to true indicates that the function executes asynchronously.

Setting this value to false indicates that the function executes synchronously.

The default value is false.

Returns:

True to indicate asynchronous execution, false synchronous.

Default:

false

cautions

public abstract java.lang.String cautions

Description of any cautions associated with this function.

The default value is an empty string.

Returns:

Cautions associated with this function.

Default:

""

example

public abstract java.lang.String example

Example on how to use this function.

The default value is an empty string.

Returns:

Example function use.

Default:

""