org.kuali.rice.kim.api.identity.external

Class EntityExternalIdentifier

java.lang.Object

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

org.kuali.rice.kim.api.identity.external.EntityExternalIdentifier

All Implemented Interfaces:

Serializable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, EntityExternalIdentifierContract

public final class EntityExternalIdentifier
extends AbstractDataTransferObject
implements EntityExternalIdentifierContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getEntityId() Gets this id of the parent identity object.
String	getExternalId() Gets this EntityExternalIdentifierContract's external id.
EntityExternalIdentifierType	getExternalIdentifierType() Gets this EntityExternalIdentifierContract's type.
String	getExternalIdentifierTypeCode() Gets this EntityExternalIdentifierContract's type code.
String	getId() The unique identifier for an object.
String	getObjectId() Return the globally unique object id of this object.
Long	getVersionNumber() Returns the version number for this 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

getEntityId

public String getEntityId()

Description copied from interface: EntityExternalIdentifierContract

Gets this id of the parent identity object.

Specified by:

getEntityId in interface EntityExternalIdentifierContract

Returns:

the identity id for this EntityEmailContract

getExternalIdentifierTypeCode

public String getExternalIdentifierTypeCode()

Description copied from interface: EntityExternalIdentifierContract

Gets this EntityExternalIdentifierContract's type code.

Specified by:

getExternalIdentifierTypeCode in interface EntityExternalIdentifierContract

Returns:

the type code for this EntityExternalIdentifierContract, or null if none has been assigned.

getExternalIdentifierType

public EntityExternalIdentifierType getExternalIdentifierType()

Description copied from interface: EntityExternalIdentifierContract

Gets this EntityExternalIdentifierContract's type.

Specified by:

getExternalIdentifierType in interface EntityExternalIdentifierContract

Returns:

the type for this EntityExternalIdentifierContract, or null if none has been assigned.

getExternalId

public String getExternalId()

Description copied from interface: EntityExternalIdentifierContract

Gets this EntityExternalIdentifierContract's external id.

Specified by:

getExternalId in interface EntityExternalIdentifierContract

Returns:

the external id for this EntityExternalIdentifierContract, or null if none has been assigned.

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

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