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

Class TermParameterDefinition

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

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

All Implemented Interfaces:

Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, TermParameterDefinitionContract

public final class TermParameterDefinition
extends AbstractDataTransferObject
implements TermParameterDefinitionContract

Immutable DTO for TermParameters. An instance represents a single parameter on a Term. Construction must be done via the TermParameterDefinition.Builder inner class.

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TermParameterDefinition.Builder
static class	TermParameterDefinition.Constants
static class	TermParameterDefinition.Elements

Method Summary

Modifier and Type	Method and Description
String	getId() The unique identifier for an object.
String	getName() Gets the name of this parameter.
String	getTermId() Gets the identifier for the term that this parameter belongs to.
String	getValue() Gets the value of this parameter.
Long	getVersionNumber() Returns the version number for this object.

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

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, 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 id

getTermId

public String getTermId()

Description copied from interface: TermParameterDefinitionContract

Gets the identifier for the term that this parameter belongs to. May be null, must not be empty.

Specified by:

getTermId in interface TermParameterDefinitionContract

Returns:

the termId

getName

public String getName()

Description copied from interface: TermParameterDefinitionContract

Gets the name of this parameter. Must not be null or empty.

Specified by:

getName in interface TermParameterDefinitionContract

Returns:

the name

getValue

public String getValue()

Description copied from interface: TermParameterDefinitionContract

Gets the value of this parameter. May be null.

Specified by:

getValue in interface TermParameterDefinitionContract

Returns:

the value

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()