com.tibco.be.model.functions

Interface BEFunction

@Retention(value=RUNTIME)
@Target(value=java.lang.annotation.ElementType.METHOD)
public interface BEFunction

This method annotation enables a static java function to become eligible to be considered as a catalog function in BusinessEvents™

Since:

5.2.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	async()
java.lang.String	cautions()
BEDeprecated	deprecated()
java.lang.String	description()
java.lang.String[]	domain() Deprecated. Replaced by BEFunction.fndomain()
Enabled	enabled()
java.lang.String	example()
FunctionDomain[]	fndomain()
FunctionParamDescriptor	freturn()
BEMapper	mapper()
java.lang.String	name()
FunctionParamDescriptor[]	params()
boolean	reevaluate()
java.lang.String	see()
java.lang.String	signature()
java.lang.String	synopsis() Deprecated. Replaced by BEFunction.description()
java.lang.String	version()

Method Detail

enabled

Enabled enabled()

Returns:

Enabled annotation value, if not specified the default Enabled annotation is used with an empty property string with a true value. It also indicates if the associated BEFunction is enabled for use.

Since:

5.2.0

deprecated

BEDeprecated deprecated()

Returns:

BEDeprecated annotation value, if not specified the default BEDeprecated annotation is used to indicate if the function has been deprecated in the BusinessEvents™ catalog.

Since:

5.2.0

name

java.lang.String name()

Returns:

The name of the function which matches the name of the function on which the BEFunction appears. If not specified the default "" value is used for showing tooltips.

Since:

5.2.0

synopsis

java.lang.String synopsis()

Deprecated. Replaced by BEFunction.description()

Returns:

A brief synopsis of the function. If not specified the default value "" is used for showing tooltips.

signature

java.lang.String signature()

Returns:

The usage signature of the function. If not specified the default value "" is used for showing tooltips.

Since:

5.2.0

params

FunctionParamDescriptor[] params()

Returns:

FunctionParamDescriptor annotation list identifying the function arguments in order, if not specified empty FunctionParamDescriptor list is used.

Since:

5.2.0

freturn

FunctionParamDescriptor freturn()

Returns:

FunctionParamDescriptor identifying the function return type, if not specified empty FunctionParamDescriptor is used.

Since:

5.2.0

version

java.lang.String version()

Returns:

The version of BusinessEvents™ from which the function was release as public API. If not specified the default value "" is used for showing tooltips.

Since:

5.2.0

see

java.lang.String see()

Returns:

A string description of any related information of the specified function.

Since:

5.2.0

mapper

BEMapper mapper()

Returns:

BEMapper annotation value, if not specified the default BEMapper annotation is used to indicate if the function used in a mapper. If not specified a default value of BEMapper is used.

description

java.lang.String description()

Returns:

a brief description of the function. if not specified a default value "" is returned.

Since:

5.2.0

async

boolean async()

Returns:

A boolean value indicating if the function is used asynchronously during rule execution. The default value is false.

reevaluate

boolean reevaluate()

Returns:

A boolean value indicating if the use of this function will cause the rules to be evaluated again. The default value is false.

cautions

java.lang.String cautions()

Returns:

A brief caution regarding the use of the function. If not specified the default value "" is used.

Since:

5.2.0

domain

java.lang.String[] domain()

Deprecated. Replaced by BEFunction.fndomain()

Returns:

A domain identifier to distinguish where the function can be used.

fndomain

FunctionDomain[] fndomain()

Returns:

A domain identifier to distinguish where the function can be used. If not specified default FunctionDomain.ACTION is used.

Since:

5.2.0

example

java.lang.String example()

Returns:

A short example of how the function should be used. If not specified the default value "" is used.

Since:

5.2.0