org.kuali.rice.kim.api.type
Class KimTypeAttribute

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.kim.api.type.KimTypeAttribute
All Implemented Interfaces:
Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, KimTypeAttributeContract

public final class KimTypeAttribute
extends AbstractDataTransferObject
implements KimTypeAttributeContract

An immutable representation of a KimTypeAttributeContract.

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

See Also:
KimTypeAttributeContract, Serialized Form

Nested Class Summary
static class KimTypeAttribute.Builder
          This builder constructs an KimTypeAttribute enforcing the constraints of the KimTypeAttributeContract.
 
Method Summary
 String getId()
          The unique identifier for an object.
 KimAttribute getKimAttribute()
          The kim attribute associated with the kim type attribute.
 String getKimTypeId()
          The kim type id associated with the kim type attribute.
 String getObjectId()
          Return the globally unique object id of this object.
 String getSortCode()
          The alpha and/or numeric code used to choose an order for displaying KimTypeAttributes.
 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

getSortCode

public String getSortCode()
Description copied from interface: KimTypeAttributeContract
The alpha and/or numeric code used to choose an order for displaying KimTypeAttributes. This can be null or blank.

Specified by:
getSortCode in interface KimTypeAttributeContract
Returns:
the sort code.

getKimAttribute

public KimAttribute getKimAttribute()
Description copied from interface: KimTypeAttributeContract
The kim attribute associated with the kim type attribute. This can be null if no KimAttributes are associated.

Specified by:
getKimAttribute in interface KimTypeAttributeContract
Returns:
the kim attribute

getKimTypeId

public String getKimTypeId()
Description copied from interface: KimTypeAttributeContract
The kim type id associated with the kim type attribute. This can be null if no KimType is associated.

Specified by:
getKimTypeId in interface KimTypeAttributeContract
Returns:
the kim type id

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

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


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