org.kuali.rice.krms.api.repository.category
Class CategoryDefinition

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.krms.api.repository.category.CategoryDefinition
All Implemented Interfaces:
Serializable, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, CategoryDefinitionContract

public class CategoryDefinition
extends AbstractDataTransferObject
implements CategoryDefinitionContract

An immutable representation of a category definition.

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

Nested Class Summary
static class CategoryDefinition.Builder
          This builder is used to construct instances of CategoryDefinition.
static class CategoryDefinition.Elements
          A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.
 
Method Summary
 String getId()
          The unique identifier for an object.
 String getName()
          Returns the name of the category definition.
 String getNamespace()
          Returns the namespace of the category definition.
 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

getName

public String getName()
Description copied from interface: CategoryDefinitionContract
Returns the name of the category definition. The combination of name and namespaceCode represent a unique business key for the category definition. The name should never be null or blank.

Specified by:
getName in interface CategoryDefinitionContract
Returns:
the name of the category definition, should never be null or blank

getNamespace

public String getNamespace()
Description copied from interface: CategoryDefinitionContract
Returns the namespace of the category definition. The combination of namespace and name represent a unique business key for the category definition. The namespace should never be null or blank.

Specified by:
getNamespace in interface CategoryDefinitionContract
Returns:
the namespace of the category definition, should never be null or blank

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


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