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

Class EntityResidency.Builder

java.lang.Object

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

All Implemented Interfaces:

Serializable, GloballyUnique, Identifiable, Versioned, ModelBuilder, EntityResidencyContract

Enclosing class:

EntityResidency

public static final class EntityResidency.Builder
extends Object
implements Serializable, ModelBuilder, EntityResidencyContract

A builder which can be used to construct EntityResidency instances. Enforces the constraints of the EntityResidencyContract.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
EntityResidency	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static EntityResidency.Builder	create()
static EntityResidency.Builder	create(EntityResidencyContract contract)
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.
void	setDeterminationMethod(String determinationMethod)
void	setEntityId(String entityId)
void	setId(String id)
void	setInState(String inState)
void	setObjectId(String objectId)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static EntityResidency.Builder create()

create

public static EntityResidency.Builder create(EntityResidencyContract contract)

build

public EntityResidency build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null

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

setEntityId

public void setEntityId(String entityId)

setDeterminationMethod

public void setDeterminationMethod(String determinationMethod)

setInState

public void setInState(String inState)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

setId

public void setId(String id)