org.kuali.rice.krms.api.repository.function

Interface FunctionParameterDefinitionContract

All Superinterfaces:

Identifiable, Versioned

All Known Implementing Classes:

FunctionParameterBo, FunctionParameterDefinition, FunctionParameterDefinition.Builder

public interface FunctionParameterDefinitionContract
extends Versioned, Identifiable

Defines the contract for a function parameter definition. A function parameter definition helps to define the "signature" of a FunctionDefinitionContract by defining the name and type of an expected parameter to the function.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns the description of this parameter.
String	getFunctionId() Returns the ID of the function to which this parameter is associated.
String	getName() Returns the name of this parameters.
String	getParameterType() Returns the type of this function parameter.
Integer	getSequenceNumber() This is the sequence number of the function parameter.

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

getId

Method Detail

getName

String getName()

Returns the name of this parameters. All parameters have a name and this value can never be null or blank. The parameter name must be unique within a given function definition.

Returns:

the name of this function parameter definition

getDescription

String getDescription()

Returns the description of this parameter. The description is intended to provide more information about a parameter and it's appropriate usage. The description is optional and will be null if a description is not defined.

Returns:

the description of this function parameter definition, or null if this parameter has no description

getParameterType

String getParameterType()

Returns the type of this function parameter. This can be one of a set of "built-in" data types or a custom data type represented as a fully qualified java class name. All parameters must have a valid type so this method should never return null or blank.

Returns:

the type of this function parameter definition

getFunctionId

String getFunctionId()

Returns the ID of the function to which this parameter is associated.

Returns:

the ID of the corresponding function

getSequenceNumber

Integer getSequenceNumber()

This is the sequence number of the function parameter. The sequence number identifies the position of the parameter in the function list.

Returns:

the sequence number of the function parameter