org.kuali.rice.krms.api.repository.proposition

Class PropositionParameter

java.lang.Object

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

org.kuali.rice.krms.api.repository.proposition.PropositionParameter

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, PropositionParameterContract

public final class PropositionParameter
extends AbstractDataTransferObject
implements PropositionParameterContract

Concrete model object implementation of KRMS Proposition Parameter immutable. Instances of PropositionParameter can be (un)marshalled to and from XML.

See Also:

PropositionParameterContract, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropositionParameter.Builder This builder is used to construct instances of PropositionParameter.
static class	PropositionParameter.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() The unique identifier for an object.
String	getParameterType() Returns the type of the parameter.
String	getPropId() Returns the Id for the parent proposition.
Integer	getSequenceNumber() Returns the sequence number of the proposition parameter.
TermDefinition	getTermValue() Returns the term value of the proposition parameter if the proposition parameter is a term.
String	getValue() Returns the value of the proposition 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

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

getPropId

public String getPropId()

Description copied from interface: PropositionParameterContract

Returns the Id for the parent proposition.

It is the Id of the parent proposition.

Specified by:

getPropId in interface PropositionParameterContract

Returns:

Id for parent parameter.

getValue

public String getValue()

Description copied from interface: PropositionParameterContract

Returns the value of the proposition parameter

It is the value of the parameter

Specified by:

getValue in interface PropositionParameterContract

Returns:

value of the parameter

getParameterType

public String getParameterType()

Description copied from interface: PropositionParameterContract

Returns the type of the parameter. Proposition parameters are one of the following types: Constant Values: numbers, strings, dates, etc. Terms: data available in the execution environment or provided by a term resolver Functions: custom functions that resolve to a value, or standard operators (equals, greater than, less than, ...)

It identified the type of the parameter.

Specified by:

getParameterType in interface PropositionParameterContract

Returns:

the parameter type code. Valid values are C, T, and F.

getSequenceNumber

public Integer getSequenceNumber()

Description copied from interface: PropositionParameterContract

Returns the sequence number of the proposition parameter. Proposition parameters are listed in Reverse Polish Notation. The sequence number (starting with 1) identifies the position of the parameter in the list.

Specified by:

getSequenceNumber in interface PropositionParameterContract

Returns:

the sequence number of the proposition parameter

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

getTermValue

public TermDefinition getTermValue()

Description copied from interface: PropositionParameterContract

Returns the term value of the proposition parameter if the proposition parameter is a term.

It is the term value of the parameter

Specified by:

getTermValue in interface PropositionParameterContract

Returns:

value of the term parameter