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

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.krms.api.repository.term.TermSpecificationDefinition
All Implemented Interfaces:
Serializable, Inactivatable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, TermSpecificationDefinitionContract

public final class TermSpecificationDefinition
extends AbstractDataTransferObject
implements TermSpecificationDefinitionContract

Immutable DTO for TermSpecifications. Construction must be done via the TermSpecificationDefinition.Builder inner class.

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:
Serialized Form

Nested Class Summary
static class TermSpecificationDefinition.Builder
          Builder for the TermSpecificationDefinition immutable DTO.
static class TermSpecificationDefinition.Cache
           
 
Method Summary
 List<CategoryDefinition> getCategories()
          Gets an ordered list of the categories which this term specification definition belongs to.
 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 getId()
          This value will be non-null for persisted
 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.
 Long getVersionNumber()
          Returns the version number for this object.
 boolean isActive()
          The active indicator for an 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()
This value will be non-null for persisted

Specified by:
getId in interface Identifiable
Returns:
the id
See Also:
Identifiable.getId()

getName

public String getName()
Description copied from interface: TermSpecificationDefinitionContract
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.

Specified by:
getName in interface TermSpecificationDefinitionContract
Returns:
the name
See Also:
TermSpecificationDefinitionContract.getName()

getNamespace

public String getNamespace()
Description copied from interface: TermSpecificationDefinitionContract
Gets the namespace of this TermSpecificationDefinitionContract. Will not be null or empty.

Specified by:
getNamespace in interface TermSpecificationDefinitionContract
Returns:
the namespace of the TermSpecificationDefinitionContract

getType

public String getType()
Description copied from interface: TermSpecificationDefinitionContract
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.

Specified by:
getType in interface TermSpecificationDefinitionContract
Returns:
the fully qualified name of the java type of values for this term.
See Also:
TermSpecificationDefinitionContract.getType()

getDescription

public String getDescription()
Description copied from interface: TermSpecificationDefinitionContract
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.

Specified by:
getDescription in interface TermSpecificationDefinitionContract
Returns:
the description for this term specification.

isActive

public boolean isActive()
Description copied from interface: Inactivatable
The active indicator for an object.

Specified by:
isActive in interface Inactivatable
Returns:
true if active false if not.

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

getCategories

public List<CategoryDefinition> getCategories()
Description copied from interface: TermSpecificationDefinitionContract
Gets an ordered list of the categories which this term specification definition belongs to. This list can be empty but will never be null.

Specified by:
getCategories in interface TermSpecificationDefinitionContract
Returns:
the list of categories for this term specification definition.
See Also:
TermSpecificationDefinitionContract.getCategories()


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.