com.tibco.rta.model.mutable
Interface MutableFunctionDescriptor

All Superinterfaces:

FunctionDescriptor, java.io.Serializable

All Known Subinterfaces:

MutableMetricFunctionDescriptor

public interface MutableFunctionDescriptor
extends FunctionDescriptor

Mutable function descriptor. Allows for modeling a function descriptor.

Nested Class Summary

static interface

MutableFunctionDescriptor.MutableFunctionParam A mutable function parameter.

Nested classes/interfaces inherited from interface com.tibco.rta.model.FunctionDescriptor

FunctionDescriptor.FunctionParam, FunctionDescriptor.FunctionParamValue

Method Summary

void	addFunctionContext(FunctionDescriptor.FunctionParam functionParam) Adds a function context.
void	addFunctionParam(FunctionDescriptor.FunctionParam functionParam) Add a function parameter to the function descriptor.
void	setCategory(java.lang.String category) Set the category of the function.
void	setDescription(java.lang.String description) Set the description of the function.
void	setImplClass(java.lang.String implClassName) Set the implementation class of the function.
void	setName(java.lang.String name) Set the name of the function

Methods inherited from interface com.tibco.rta.model.FunctionDescriptor

getCategory, getDescription, getFunctionContext, getFunctionContext, getFunctionContexts, getFunctionParam, getFunctionParam, getFunctionParams, getImplClass, getName

Method Detail

setName

void setName(java.lang.String name)

Set the name of the function

Parameters:

name -

setCategory

void setCategory(java.lang.String category)

Set the category of the function.

Parameters:

category -

setDescription

void setDescription(java.lang.String description)

Set the description of the function.

Parameters:

description -

setImplClass

void setImplClass(java.lang.String implClassName)

Set the implementation class of the function. Should extend SingleValueMetricFunction or a MultivalueMetricFunction.

Parameters:

implClassName -

addFunctionParam

void addFunctionParam(FunctionDescriptor.FunctionParam functionParam)
                      throws UndefinedSchemaElementException,
                             DuplicateSchemaElementException

Add a function parameter to the function descriptor.

Parameters:

functionParam - The parameter to add.

Throws:

UndefinedSchemaElementException

DuplicateSchemaElementException

addFunctionContext

void addFunctionContext(FunctionDescriptor.FunctionParam functionParam)
                        throws UndefinedSchemaElementException,
                               DuplicateSchemaElementException

Adds a function context.

Parameters:

functionParam - function param to add

Throws:

UndefinedSchemaElementException

DuplicateSchemaElementException