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

Interface TermSpecificationDefinitionContract

All Superinterfaces:

Identifiable, Inactivatable, Versioned

All Known Implementing Classes:

TermSpecificationBo, TermSpecificationDefinition, TermSpecificationDefinition.Builder

public interface TermSpecificationDefinitionContract
extends Identifiable, Inactivatable, Versioned

The contract for a TermSpecificationDefinition which defines important information about a term (see TermDefinitionContract). A term specification should be uniquely identifiable by its name and namespace. This key is important for determining how the fact value for a term can be resolved.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
List<? extends CategoryDefinitionContract>	getCategories() Gets an ordered list of the categories which this term specification definition belongs to.
List<String>	getContextIds() Gets a list of the IDs for the contexts this TermSpecification can be used in.
String	getDescription() Gets the description for this term specification, which will typically be a suitable description for any term having this specification as well.
String	getName() Gets the name for this TermSpecificationDefinitionContract.
String	getNamespace() Gets the namespace of this TermSpecificationDefinitionContract.
String	getType() Gets the fully qualified class name for the values of any term having this specification.

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

getId

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

isActive

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

getVersionNumber

Method Detail

getName

String getName()

Gets the name for this TermSpecificationDefinitionContract. This is an important key that must be unique within a namespace, and is used to determine how to resolve any terms having this specification. Will not be null or empty.

Returns:

the name

getNamespace

String getNamespace()

Gets the namespace of this TermSpecificationDefinitionContract. Will not be null or empty.

Returns:

the namespace of the TermSpecificationDefinitionContract

getType

String getType()

Gets the fully qualified class name for the values of any term having this specification. E.g. if the type of the fact values for the "total dollar amount of a grant" term was BigDecimal, then the term specification's type would be the String "java.math.BigDecimal". Will never return null or the empty string.

Returns:

the fully qualified name of the java type of values for this term.

getDescription

String getDescription()

Gets the description for this term specification, which will typically be a suitable description for any term having this specification as well. May return null if no description is specified for the term specification.

Returns:

the description for this term specification.

getCategories

List<? extends CategoryDefinitionContract> getCategories()

Gets an ordered list of the categories which this term specification definition belongs to. This list can be empty but will never be null.

Returns:

the list of categories for this term specification definition.

getContextIds

List<String> getContextIds()

Gets a list of the IDs for the contexts this TermSpecification can be used in.

Returns:

the list of contexts for this term specification definition

Since:

2.2