org.kuali.rice.krms.api.repository.type
Class KrmsAttributeDefinition

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

public final class KrmsAttributeDefinition
extends AbstractDataTransferObject
implements KrmsAttributeDefinitionContract

Concrete model object implementation of KRMS KrmsAttributeDefinition.

immutable. To construct an instance of a KrmsTypeAttribute, use the KrmsTypeAttribute.Builder class. Instances of KrmsAttributeDefinition can be (un)marshalled to and from XML.

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

Nested Class Summary
static class KrmsAttributeDefinition.Builder
          This builder is used to construct instances of KrmsAttributeDefinition.
static class KrmsAttributeDefinition.Cache
           
static class KrmsAttributeDefinition.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 getComponentName()
          Returns the name of the component used to display the attribute.
 String getDescription()
          Returns the description of the attribute.
 String getId()
          The unique identifier for an object.
 String getLabel()
          Returns the label of this attribute definition.
 String getName()
          Returns the name of this attribute definition.
 String getNamespace()
          Returns the namespace of this attribute definition.
 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()
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: KrmsAttributeDefinitionContract
Returns the name of this attribute definition.

All attribute definitions have a name and namespace, so this value can not be null or blank. The combination of name and namespace must be unique within the entire KRMS system.

Specified by:
getName in interface KrmsAttributeDefinitionContract
Returns:
name for this attribute definition

getNamespace

public String getNamespace()
Description copied from interface: KrmsAttributeDefinitionContract
Returns the namespace of this attribute definition.

The namespace provides scope of the the attribute definition. All attribute definition have a name and namespace, so this field may not be null or blank. The combination of name and namespace must be unique within the entire KRMS system.

Specified by:
getNamespace in interface KrmsAttributeDefinitionContract
Returns:
the namespace of this attribute definition

getLabel

public String getLabel()
Description copied from interface: KrmsAttributeDefinitionContract
Returns the label of this attribute definition.

This is an optional field and may be null or blank.

Specified by:
getLabel in interface KrmsAttributeDefinitionContract
Returns:
the label to be used when displaying the attribute

getDescription

public String getDescription()
Description copied from interface: KrmsAttributeDefinitionContract
Returns the description of the attribute.

This is an option field and may be null or blank.

Specified by:
getDescription in interface KrmsAttributeDefinitionContract
Returns:
a text description of the attribute

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.

getComponentName

public String getComponentName()
Description copied from interface: KrmsAttributeDefinitionContract
Returns the name of the component used to display the attribute.

Specified by:
getComponentName in interface KrmsAttributeDefinitionContract
Returns:
the component name of the of the attribute

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-2012 The Kuali Foundation. All Rights Reserved.