org.kuali.rice.coreservice.impl.parameter

Class ParameterBo

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.coreservice.impl.parameter.ParameterBo

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, GloballyUnique, Versioned, ModelObjectBasic, ParameterContract, ParameterEbo, BusinessObject, ExternalizableBusinessObject, PersistableBusinessObject

@Entity
public class ParameterBo
extends PersistableBusinessObjectBase
implements ParameterEbo

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, newCollectionRecord, objectId, versionNumber

Constructor Summary

Constructors

Constructor and Description
ParameterBo()

Method Summary

Methods

Modifier and Type	Method and Description
static ParameterBo	from(Parameter im) Converts a immutable object to its mutable counterpart
String	getApplicationId() This is the application id for the Parameter.
ComponentBo	getComponent()
String	getComponentCode() This is the component code for the parameter.
DerivedComponentBo	getDerivedComponent()
String	getDescription() This is the description for what the parameter is used for.
EvaluationOperator	getEvaluationOperator() This is the evaluation operator for the parameter.
String	getEvaluationOperatorCode() Returns the evaluation operator code.
String	getName() The name of the parameter.
NamespaceBo	getNamespace()
String	getNamespaceCode() This is the namespace for the parameter.
ParameterId	getParameterId()
ParameterTypeBo	getParameterType() This is the type for the parameter.
String	getParameterTypeCode()
String	getValue() The value of the parameter.
void	setApplicationId(String applicationId)
void	setComponent(ComponentBo component)
void	setComponentCode(String componentCode)
void	setDerivedComponent(DerivedComponentBo derivedComponent)
void	setDescription(String description)
void	setEvaluationOperatorCode(String evaluationOperatorCode)
void	setName(String name)
void	setNamespace(NamespaceBo namespace)
void	setNamespaceCode(String namespaceCode)
void	setParameterType(ParameterTypeBo parameterType)
void	setParameterTypeCode(String parameterTypeCode)
void	setValue(String value)
static Parameter	to(ParameterBo bo) Converts a mutable bo to its immutable counterpart

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getLegacyDataAdapter, getObjectId, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.coreservice.framework.parameter.ParameterEbo

getObjectId, getVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Constructor Detail

ParameterBo

public ParameterBo()

Method Detail

to

public static Parameter to(ParameterBo bo)

Converts a mutable bo to its immutable counterpart

Parameters:

bo - the mutable business object

Returns:

the immutable object

from

public static ParameterBo from(Parameter im)

Converts a immutable object to its mutable counterpart

Parameters:

im - immutable object

Returns:

the mutable bo

getParameterType

public ParameterTypeBo getParameterType()

Description copied from interface: ParameterEbo

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

Specified by:

getParameterType in interface ParameterContract

Specified by:

getParameterType in interface ParameterEbo

Returns:

type

getEvaluationOperator

public EvaluationOperator getEvaluationOperator()

Description copied from interface: ParameterEbo

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

Specified by:

getEvaluationOperator in interface ParameterEbo

Returns:

evaluation operator

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: ParameterEbo

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

Specified by:

getNamespaceCode in interface ParameterEbo

Returns:

namespace code

setNamespaceCode

public void setNamespaceCode(String namespaceCode)

getComponentCode

public String getComponentCode()

Description copied from interface: ParameterEbo

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

Specified by:

getComponentCode in interface ParameterEbo

Returns:

component

setComponentCode

public void setComponentCode(String componentCode)

getName

public String getName()

Description copied from interface: ParameterEbo

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

Specified by:

getName in interface ParameterContract

Specified by:

getName in interface ParameterEbo

Returns:

name

setName

public void setName(String name)

getApplicationId

public String getApplicationId()

Description copied from interface: ParameterEbo

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

Specified by:

getApplicationId in interface ParameterEbo

Returns:

application id

setApplicationId

public void setApplicationId(String applicationId)

getValue

public String getValue()

Description copied from interface: ParameterEbo

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

Specified by:

getValue in interface ParameterContract

Specified by:

getValue in interface ParameterEbo

Returns:

value

setValue

public void setValue(String value)

getDescription

public String getDescription()

Description copied from interface: ParameterEbo

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

Specified by:

getDescription in interface ParameterEbo

Returns:

description

setDescription

public void setDescription(String description)

getParameterTypeCode

public String getParameterTypeCode()

setParameterTypeCode

public void setParameterTypeCode(String parameterTypeCode)

setParameterType

public void setParameterType(ParameterTypeBo parameterType)

getEvaluationOperatorCode

public String getEvaluationOperatorCode()

Returns the evaluation operator code. View EvaluationOperator for applicable codes

Returns:

setEvaluationOperatorCode

public void setEvaluationOperatorCode(String evaluationOperatorCode)

getNamespace

public NamespaceBo getNamespace()

setNamespace

public void setNamespace(NamespaceBo namespace)

getComponent

public ComponentBo getComponent()

setComponent

public void setComponent(ComponentBo component)

getDerivedComponent

public DerivedComponentBo getDerivedComponent()

setDerivedComponent

public void setDerivedComponent(DerivedComponentBo derivedComponent)

getParameterId

public ParameterId getParameterId()