com.tibco.rta.model
Interface FunctionDescriptor

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ActionFunctionDescriptor, MetricFunctionDescriptor, MutableFunctionDescriptor, MutableMetricDescriptor, MutableMetricFunctionDescriptor

public interface FunctionDescriptor
extends java.io.Serializable

Describes a function used for computation

Nested Class Summary

static interface	FunctionDescriptor.FunctionParam Describes a funciton parameter
static interface	FunctionDescriptor.FunctionParamValue Represents a function parameter with a corresponding value.

Method Summary

java.lang.String	getCategory() Returns the category
java.lang.String	getDescription() Returns the description
FunctionDescriptor.FunctionParam	getFunctionContext(int index)
FunctionDescriptor.FunctionParam	getFunctionContext(java.lang.String contextName)
java.util.Collection<FunctionDescriptor.FunctionParam>	getFunctionContexts()
FunctionDescriptor.FunctionParam	getFunctionParam(int index)
FunctionDescriptor.FunctionParam	getFunctionParam(java.lang.String paramName)
java.util.Collection<FunctionDescriptor.FunctionParam>	getFunctionParams() List of function parameters in the order in which they appear in the "compute" method if the implementation class
java.lang.String	getImplClass() Returns the implementation class.
java.lang.String	getName()

Method Detail

getName

java.lang.String getName()

Returns:

Function name.

getDescription

java.lang.String getDescription()

Returns the description

Returns:

getCategory

java.lang.String getCategory()

Returns the category

Returns:

getImplClass

java.lang.String getImplClass()

Returns the implementation class. Must extend a SingleValueMetricFunction or a MultiValueMetricFunction

Returns:

getFunctionParam

FunctionDescriptor.FunctionParam getFunctionParam(java.lang.String paramName)

getFunctionParam

FunctionDescriptor.FunctionParam getFunctionParam(int index)

getFunctionParams

java.util.Collection<FunctionDescriptor.FunctionParam> getFunctionParams()

List of function parameters in the order in which they appear in the "compute" method if the implementation class

Returns:

getFunctionContext

FunctionDescriptor.FunctionParam getFunctionContext(java.lang.String contextName)

getFunctionContext

FunctionDescriptor.FunctionParam getFunctionContext(int index)

getFunctionContexts

java.util.Collection<FunctionDescriptor.FunctionParam> getFunctionContexts()