org.kuali.rice.kim.api.identity

Class CodedAttribute

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kim.api.identity.CodedAttribute

All Implemented Interfaces:

Serializable, Inactivatable, Coded, GloballyUnique, Versioned, ModelObjectBasic, ModelObjectComplete, CodedAttributeContract

public final class CodedAttribute
extends AbstractDataTransferObject
implements CodedAttributeContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodedAttribute.Builder A builder which can be used to construct CodedAttribute instances.
static class	CodedAttribute.Cache

Method Summary

Modifier and Type	Method and Description
String	getCode() The code value for this object.
String	getName() This the name for the AddressType.
String	getObjectId() Return the globally unique object id of this object.
String	getSortCode() This the sort code for the AddressType.
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, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Description copied from interface: CodedAttributeContract

This the name for the AddressType. This can be null or a blank string.

Specified by:

getName in interface CodedAttributeContract

Returns:

the name of the AddressType

getCode

public String getCode()

Description copied from interface: Coded

The code value for this object. In general a code value cannot be null or a blank string.

Specified by:

getCode in interface Coded

Returns:

the code value for this object.

getSortCode

public String getSortCode()

Description copied from interface: CodedAttributeContract

This the sort code for the AddressType. This can be null or a blank string.

Specified by:

getSortCode in interface CodedAttributeContract

Returns:

the sort code of the AddressType

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

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.