Parameter

Name Parameter
Usage ParameterRepositoryService
createParameter updateParameter getParameter
ParameterQueryResults
Type Complex

Description

An immutable representation of a {@link ParameterContract}.


To construct an instance of a Parameter, use the {@link Parameter.Builder} class.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
applicationId Application Id String 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.

 Required   One No  
namespaceCode Namespace Code String 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.

 Required   One No  
componentCode Component Code String 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.

 Required   One No  
name Name String The name of the parameter. This cannot be null or a blank string. Required   One No  
value Value String The value of the parameter. This can be null or a blank string.     One No  
description Description String This is the description for what the parameter is used for. This can be null or a blank string.     One No  
parameterType Parameter Type ParameterType 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 {@link #getEvaluationOperator()}

 Required   One No  
evaluationOperator Evaluation Operator EvaluationOperator This is the evaluation operator for the parameter. This can be null.


This allows parameters to be used as primitive business rules.

     One No  
versionNumber Version Number Long 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.		     One No  
objectId Object Id String 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.		     One No