org.kuali.rice.core.api.parameter
Interface ParameterContract

All Superinterfaces:

GloballyUnique, Versioned

All Known Implementing Classes:

Parameter, Parameter.Builder

public interface ParameterContract
extends Versioned, GloballyUnique

This is the contract for a Parameter. The concept of a parameter is a key=value pair that is associated with a rice enabled application.

When thinking of a parameter in terms of a key=value pair, the following defines the key and value parts: the key of a parameter consists of the following pieces:

1. applicationId
2. namespaceCode
3. componentCode
4. name

the value consists of the value

Method Summary

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.
ParameterTypeContract	getParameterType() This is the type for the parameter.
String	getValue() The value of the 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.GloballyUnique

getObjectId

Method Detail

getApplicationId

String getApplicationId()

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.

Returns:

application id

getNamespaceCode

String getNamespaceCode()

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.

Returns:

namespace code

getComponentCode

String getComponentCode()

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.

Returns:

component

getName

String getName()

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

Returns:

name

getValue

String getValue()

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

Returns:

value

getDescription

String getDescription()

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

Returns:

description

getEvaluationOperator

EvaluationOperator getEvaluationOperator()

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

This allows parameters to be used as primitive business rules.

Returns:

evaluation operator

getParameterType

ParameterTypeContract getParameterType()

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 getEvaluationOperator()

Returns:

type