org.kuali.rice.kim.api.identity.residency
Class EntityResidency

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.identity.residency.EntityResidency

All Implemented Interfaces:

Serializable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, EntityResidencyContract

public final class EntityResidency
extends AbstractDataTransferObject
implements EntityResidencyContract

See Also:

Serialized Form

Nested Class Summary

static class

EntityResidency.Builder A builder which can be used to construct EntityResidency instances.

Method Summary

String	getDeterminationMethod() Gets this EntityResidencyContract's determination method.
String	getEntityId() Gets this EntityResidencyContract's identity id.
String	getId() The unique identifier for an object.
String	getInState() Gets the state this EntityResidencyContract is in.
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, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, 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: EntityResidencyContract

Gets this EntityResidencyContract's identity id.

Specified by:

getEntityId in interface EntityResidencyContract

Returns:

the identity id for this EntityResidencyContract, or null if none has been assigned.

getDeterminationMethod

public String getDeterminationMethod()

Description copied from interface: EntityResidencyContract

Gets this EntityResidencyContract's determination method.

Specified by:

getDeterminationMethod in interface EntityResidencyContract

Returns:

the determination method for this EntityResidencyContract, or null if none has been assigned.

getInState

public String getInState()

Description copied from interface: EntityResidencyContract

Gets the state this EntityResidencyContract is in.

Specified by:

getInState in interface EntityResidencyContract

Returns:

the state this EntityResidencyContract is in, 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