org.kuali.rice.krms.impl.repository

Class FunctionParameterBo

java.lang.Object

org.kuali.rice.krms.impl.repository.FunctionParameterBo

All Implemented Interfaces:

Serializable, Identifiable, Versioned, FunctionParameterDefinitionContract

@Entity
public class FunctionParameterBo
extends Object
implements FunctionParameterDefinitionContract, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	versionNumber

Constructor Summary

Constructors

Constructor and Description
FunctionParameterBo()

Method Summary

Methods

Modifier and Type	Method and Description
static FunctionParameterBo	from(FunctionParameterDefinition im) Converts a immutable object to it's mutable bo counterpart
static List<FunctionParameterBo>	from(List<FunctionParameterDefinition> ims)
String	getDescription() Returns the description of this parameter.
FunctionBo	getFunction()
String	getFunctionId() Returns the ID of the function to which this parameter is associated.
String	getId() The unique identifier for an object.
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() Returns the version number for this object.
void	setDescription(String description)
void	setFunction(FunctionBo function)
void	setId(String id)
void	setName(String name)
void	setParameterType(String parameterType)
void	setSequenceNumber(Integer sequenceNumber)
void	setVersionNumber(Long versionNumber)
static FunctionParameterDefinition	to(FunctionParameterBo bo) Converts a mutable bo to it's immutable counterpart
static List<FunctionParameterDefinition>	to(List<FunctionParameterBo> bos) Converts a list of mutable bos to it's immutable counterpart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

versionNumber

protected Long versionNumber

Constructor Detail

FunctionParameterBo

public FunctionParameterBo()

Method Detail

to

public static FunctionParameterDefinition to(FunctionParameterBo bo)

Converts a mutable bo to it's immutable counterpart

Parameters:

bo - the mutable business object

Returns:

the immutable object

to

public static List<FunctionParameterDefinition> to(List<FunctionParameterBo> bos)

Converts a list of mutable bos to it's immutable counterpart

Parameters:

bos - the list of mutable business objects

Returns:

and immutable list containing the immutable objects

from

public static FunctionParameterBo from(FunctionParameterDefinition im)

Converts a immutable object to it's mutable bo counterpart

Parameters:

im - immutable object

Returns:

the mutable bo

from

public static List<FunctionParameterBo> from(List<FunctionParameterDefinition> ims)

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

setId

public void setId(String id)

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

setName

public void setName(String name)

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

setDescription

public void setDescription(String description)

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

getFunction

public FunctionBo getFunction()

setFunction

public void setFunction(FunctionBo function)

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

setParameterType

public void setParameterType(String parameterType)

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

setSequenceNumber

public void setSequenceNumber(Integer sequenceNumber)

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

setVersionNumber

public void setVersionNumber(Long versionNumber)