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

java.lang.Object
  org.kuali.rice.krms.api.repository.PropositionParameter

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, PropositionParameterContract

public final class PropositionParameter
extends Object
implements PropositionParameterContract, ModelObjectComplete

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

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.
static class	PropositionParameter.ParameterTypes This enumeration identifies the valid PropositionParameter parameter type codes

Method Summary

boolean	equals(Object obj) All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.
String	getId() This is the Id for the proposition parameter
String	getParameterType() This is the type of the parameter.
String	getPropId() This is the Id for the parent proposition.
Integer	getSequenceNumber() This is the sequence number of the proposition parameter.
String	getValue() This is the value of the proposition parameter
int	hashCode() All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.
String	toString() This will return a proper string representation of the Model Object.

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: PropositionParameterContract

This is the Id for the proposition parameter

It is the Id of a proposition parameter.

Specified by:

getId in interface PropositionParameterContract

Returns:

Id for proposition parameter.

getPropId

public String getPropId()

Description copied from interface: PropositionParameterContract

This is 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

This is 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

This is 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

This is 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

hashCode

public int hashCode()

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.

Specified by:

hashCode in interface ModelObjectComplete

Overrides:

hashCode in class Object

Returns:

the hashCode value

equals

public boolean equals(Object obj)

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.

Specified by:

equals in interface ModelObjectComplete

Overrides:

equals in class Object

Parameters:

obj - to object to compare for equality

Returns:

if equal

toString

public String toString()

Description copied from interface: ModelObjectBasic

This will return a proper string representation of the Model Object. All of the fields comprising the "public" api should be represented in the return value.

Specified by:

toString in interface ModelObjectBasic

Overrides:

toString in class Object

Returns:

the string representation