org.kuali.rice.krms.api.repository.term

Interface TermDefinitionContract

All Superinterfaces:

Identifiable, Versioned

All Known Implementing Classes:

TermDefinition, TermDefinition.Builder

public interface TermDefinitionContract
extends Identifiable, Versioned

The contract for a TermDefinition which defines a term. Conceptually, a term describes a piece of data used in a proposition, e.g. the total dollar amount of a grant. It is a place holder, not a specific fact value as the amount will vary between grants.

In KRMS' model, a term contains a term specification which specifies some import details about the term.

A term may have parameters associated with it. The parameters are intended to be used during term resolution to reify the fact value for the term. Parameters allow multiple terms to exist for a single specification.

Author:

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

See Also:

TermDefinition, Term, TermSpecificationDefinitionContract

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the description for this TermDefinitionContract.
List<? extends TermParameterDefinitionContract>	getParameters() Get any parameters specified on this TermDefinitionContract.
TermSpecificationDefinitionContract	getSpecification() Get the associated TermSpecificationDefinitionContract which specifies some important details about the term.

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 Detail

getSpecification

TermSpecificationDefinitionContract getSpecification()

Get the associated TermSpecificationDefinitionContract which specifies some important details about the term. Will not be null.

Returns:

the term specification

getDescription

String getDescription()

Get the description for this TermDefinitionContract. May be null.

Returns:

the description

getParameters

List<? extends TermParameterDefinitionContract> getParameters()

Get any parameters specified on this TermDefinitionContract. May be empty, but never null.

Returns:

the term's parameters