org.kuali.rice.coreservice.api.parameter

Class Parameter

java.lang.Object

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

org.kuali.rice.coreservice.api.parameter.Parameter

All Implemented Interfaces:

Serializable, GloballyUnique, Versioned, ModelObjectBasic, ModelObjectComplete, ParameterContract

public final class Parameter
extends AbstractDataTransferObject
implements ParameterContract

An immutable representation of a ParameterContract.

To construct an instance of a Parameter, use the Parameter.Builder class.

See Also:

ParameterContract, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameter.Builder This builder constructs an Parameter enforcing the constraints of the ParameterContract.
static class	Parameter.Cache

Method Summary

Methods

Modifier and Type	Method and Description
String	getApplicationId() This is the application id for the Parameter.
String	getComponentCode() This is the component code for the parameter.
String	getDescription() This is the description for what the parameter is used for.
EvaluationOperator	getEvaluationOperator() This is the evaluation operator for the parameter.
String	getName() The name of the parameter.
String	getNamespaceCode() This is the namespace for the parameter.
String	getObjectId() Return the globally unique object id of this object.
ParameterKey	getParameterKey()
ParameterType	getParameterType() This is the type for the parameter.
String	getValue() The value of the parameter.
Long	getVersionNumber() Returns the version number for this object.

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 Detail

getApplicationId

public String getApplicationId()

Description copied from interface: ParameterContract

This is the application id for the Parameter. This cannot be null or a blank string.

It is a way of assigning the Parameter to a specific rice application or rice ecosystem.

Specified by:

getApplicationId in interface ParameterContract

Returns:

application id

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: ParameterContract

This is the namespace for the parameter. This cannot be null or a blank string.

It is a way of assigning the parameter to a logical grouping within a rice application or rice ecosystem.

Specified by:

getNamespaceCode in interface ParameterContract

Returns:

namespace code

getComponentCode

public String getComponentCode()

Description copied from interface: ParameterContract

This is the component code for the parameter. This cannot be null.

It is a way of assigning a parameter to a functional component within a rice application or rice ecosystem.

Specified by:

getComponentCode in interface ParameterContract

Returns:

component

getName

public String getName()

Description copied from interface: ParameterContract

The name of the parameter. This cannot be null or a blank string.

Specified by:

getName in interface ParameterContract

Returns:

name

getValue

public String getValue()

Description copied from interface: ParameterContract

The value of the parameter. This can be null or a blank string.

Specified by:

getValue in interface ParameterContract

Returns:

value

getDescription

public String getDescription()

Description copied from interface: ParameterContract

This is the description for what the parameter is used for. This can be null or a blank string.

Specified by:

getDescription in interface ParameterContract

Returns:

description

getParameterType

public ParameterType getParameterType()

Description copied from interface: ParameterContract

This is the type for the parameter. This cannot be null.

Some parameters have special types in rice which may have special meaning and is related to the ParameterContract.getEvaluationOperator()

Specified by:

getParameterType in interface ParameterContract

Returns:

type

getEvaluationOperator

public EvaluationOperator getEvaluationOperator()

Description copied from interface: ParameterContract

This is the evaluation operator for the parameter. This can be null.

This allows parameters to be used as primitive business rules.

Specified by:

getEvaluationOperator in interface ParameterContract

Returns:

evaluation operator

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

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:

getObjectId in interface GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet

getParameterKey

public ParameterKey getParameterKey()