org.kuali.rice.kim.api.common.attribute
Class KimAttribute

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.common.attribute.KimAttribute

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, KimAttributeContract

public final class KimAttribute
extends AbstractDataTransferObject
implements KimAttributeContract

An immutable representation of a KimAttributeContract.

To construct an instance of a KimAttribute, use the KimAttribute.Builder class.

See Also:

KimAttributeContract, Serialized Form

Nested Class Summary

static class

KimAttribute.Builder This builder constructs an KimAttribute enforcing the constraints of the KimAttributeContract.

Method Summary

String	getAttributeLabel() The label for the kim attribute.
String	getAttributeName() The name of the attribute on the KimAttributeContract.getComponentName().
String	getComponentName() A fully-qualified class name which contains the KimAttributeContract.getAttributeName().
String	getId() The unique identifier for an object.
String	getNamespaceCode() The namespace code that this kim attribute belongs too.
String	getObjectId() Return the globally unique object id of this object.
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

getComponentName

public String getComponentName()

Description copied from interface: KimAttributeContract

A fully-qualified class name which contains the KimAttributeContract.getAttributeName(). This cannot be null or a blank string.

Specified by:

getComponentName in interface KimAttributeContract

Returns:

the name

getAttributeName

public String getAttributeName()

Description copied from interface: KimAttributeContract

The name of the attribute on the KimAttributeContract.getComponentName(). This cannot be null or a blank string.

Specified by:

getAttributeName in interface KimAttributeContract

Returns:

the name

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: KimAttributeContract

The namespace code that this kim attribute belongs too. This cannot be null or a blank string.

Specified by:

getNamespaceCode in interface KimAttributeContract

Returns:

namespace code

getAttributeLabel

public String getAttributeLabel()

Description copied from interface: KimAttributeContract

The label for the kim attribute. This is optional and can be null or blank.

Specified by:

getAttributeLabel in interface KimAttributeContract

Returns:

the label

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

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.

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:

getObjectId in interface GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet