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

Interface PropositionParameterContract

All Superinterfaces:

Identifiable, Versioned

All Known Implementing Classes:

PropositionParameter, PropositionParameter.Builder

public interface PropositionParameterContract
extends Identifiable, Versioned

The contract for PropositionParameter

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method	Description
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

Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

getId

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Method Details

getPropId

String getPropId()

Returns the Id for the parent proposition.

It is the Id of the parent proposition.

Returns:

Id for parent parameter.

getValue

String getValue()

Returns the value of the proposition parameter

It is the value of the parameter

Returns:

value of the parameter

getTermValue

TermDefinition getTermValue()

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

It is the term value of the parameter

Returns:

value of the term parameter

getParameterType

String getParameterType()

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.

Returns:

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

getSequenceNumber

Integer getSequenceNumber()

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.

Returns:

the sequence number of the proposition parameter