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

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.krms.api.repository.term.TermDefinition

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, TermDefinitionContract

public final class TermDefinition
extends AbstractDataTransferObject
implements TermDefinitionContract

Immutable DTO for Terms. Construction must be done via the TermDefinition.Builder inner class.

Author:

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

See Also:

Serialized Form

Nested Class Summary

static class

TermDefinition.Builder ModelBuilder for TermDefinitions.

Method Summary

String	getDescription()
String	getId() The unique identifier for an object.
List<TermParameterDefinition>	getParameters()
TermSpecificationDefinition	getSpecification()
Long	getVersionNumber() Returns the version number for this object.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, hashCode, 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 termId. May be null if this TermDefinition hasn't been persisted.

getSpecification

public TermSpecificationDefinition getSpecification()

Specified by:

getSpecification in interface TermDefinitionContract

Returns:

the specification. Will never be null.

getDescription

public String getDescription()

Specified by:

getDescription in interface TermDefinitionContract

Returns:

the description for this TermDefinitionContract

getParameters

public List<TermParameterDefinition> getParameters()

Specified by:

getParameters in interface TermDefinitionContract

Returns:

the parameters. May be empty, but will never be null.

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

See Also:

Versioned.getVersionNumber()