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

Class FunctionParameterDefinition

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

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

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, FunctionParameterDefinitionContract

public class FunctionParameterDefinition
extends AbstractDataTransferObject
implements FunctionParameterDefinitionContract

An immutable representation of a function parameter definition.

Author:

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

See Also:

• FunctionParameterDefinitionContract
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FunctionParameterDefinition.Builder	A builder which can be used to construct FunctionParameterDefinition instances.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of this parameter.
String	getFunctionId()	Returns the ID of the function to which this parameter is associated.
String	getId()
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.
Long	getVersionNumber()

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getId

public String getId()

Specified by:

getId in interface Identifiable

getName

public String getName()

Description copied from interface: FunctionParameterDefinitionContract

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.

Specified by:

getName in interface FunctionParameterDefinitionContract

Returns:

the name of this function parameter definition

getDescription

public String getDescription()

Description copied from interface: FunctionParameterDefinitionContract

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.

Specified by:

getDescription in interface FunctionParameterDefinitionContract

Returns:

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

getParameterType

public String getParameterType()

Description copied from interface: FunctionParameterDefinitionContract

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.

Specified by:

getParameterType in interface FunctionParameterDefinitionContract

Returns:

the type of this function parameter definition

getFunctionId

public String getFunctionId()

Description copied from interface: FunctionParameterDefinitionContract

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

Specified by:

getFunctionId in interface FunctionParameterDefinitionContract

Returns:

the ID of the corresponding function

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface Versioned

getSequenceNumber

public Integer getSequenceNumber()

Description copied from interface: FunctionParameterDefinitionContract

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

Specified by:

getSequenceNumber in interface FunctionParameterDefinitionContract

Returns:

the sequence number of the function parameter