org.kuali.rice.kim.api.identity.external
Class EntityExternalIdentifierHistory.Builder

java.lang.Object
  org.kuali.rice.kim.api.identity.external.EntityExternalIdentifierHistory.Builder

All Implemented Interfaces:

Serializable, Inactivatable, InactivatableFromTo, GloballyUnique, Historical, Identifiable, Versioned, ModelBuilder, EntityExternalIdentifierContract, EntityExternalIdentifierHistoryContract

Enclosing class:

EntityExternalIdentifierHistory

public static final class EntityExternalIdentifierHistory.Builder
extends Object
implements Serializable, ModelBuilder, EntityExternalIdentifierHistoryContract

A builder which can be used to construct EntityExternalIdentifierHistory instances. Enforces the constraints of the EntityExternalIdentifierContract.

See Also:

Serialized Form

Method Summary

EntityExternalIdentifierHistory	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static EntityExternalIdentifierHistory.Builder	create()
static EntityExternalIdentifierHistory.Builder	create(EntityExternalIdentifierHistoryContract contract)
org.joda.time.DateTime	getActiveFromDate() Gets the date for which the record become active.
org.joda.time.DateTime	getActiveToDate() Gets the date for which the record become inactive.
String	getEntityId() Gets this id of the parent identity object.
String	getExternalId() Gets this EntityExternalIdentifierContract's external id.
EntityExternalIdentifierTypeHistory.Builder	getExternalIdentifierType() Gets this EntityExternalIdentifierHistoryContract's type.
String	getExternalIdentifierTypeCode() Gets this EntityExternalIdentifierContract's type code.
Long	getHistoryId()
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.
boolean	isActive() The active indicator for an object.
boolean	isActive(org.joda.time.DateTime activeAsOf) Returns if the record is active for a given Time.
boolean	isActiveNow()
void	setActiveFromDate(org.joda.time.DateTime activeFromDate)
void	setActiveToDate(org.joda.time.DateTime activeToDate)
void	setEntityId(String entityId)
void	setExternalId(String externalId)
void	setExternalIdentifierType(EntityExternalIdentifierTypeHistory.Builder externalIdentifierType)
void	setExternalIdentifierTypeCode(String externalIdentifierTypeCode)
void	setHistoryId(Long historyId)
void	setId(String id)
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 EntityExternalIdentifierHistory.Builder create()

create

public static EntityExternalIdentifierHistory.Builder create(EntityExternalIdentifierHistoryContract contract)

build

public EntityExternalIdentifierHistory 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: 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 EntityExternalIdentifierTypeHistory.Builder getExternalIdentifierType()

Description copied from interface: EntityExternalIdentifierHistoryContract

Gets this EntityExternalIdentifierHistoryContract's type.

Specified by:

getExternalIdentifierType in interface EntityExternalIdentifierContract

Specified by:

getExternalIdentifierType in interface EntityExternalIdentifierHistoryContract

Returns:

the type for this EntityExternalIdentifierHistoryContract, 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

getHistoryId

public Long getHistoryId()

Specified by:

getHistoryId in interface Historical

isActiveNow

public boolean isActiveNow()

Specified by:

isActiveNow in interface Historical

isActive

public boolean isActive(org.joda.time.DateTime activeAsOf)

Description copied from interface: InactivatableFromTo

Returns if the record is active for a given Time. If the activeAsOfDate is null will return null.

Specified by:

isActive in interface InactivatableFromTo

Returns:

true if active false if not

getActiveFromDate

public org.joda.time.DateTime getActiveFromDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become active. Can be null.

Specified by:

getActiveFromDate in interface InactivatableFromTo

Returns:

Timestamp of active from date

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.

getActiveToDate

public org.joda.time.DateTime getActiveToDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become inactive. Can be null.

Specified by:

getActiveToDate in interface InactivatableFromTo

Returns:

Timestamp of active to date

setHistoryId

public void setHistoryId(Long historyId)

setActiveFromDate

public void setActiveFromDate(org.joda.time.DateTime activeFromDate)

setActiveToDate

public void setActiveToDate(org.joda.time.DateTime activeToDate)

setEntityId

public void setEntityId(String entityId)

setExternalIdentifierTypeCode

public void setExternalIdentifierTypeCode(String externalIdentifierTypeCode)

setExternalIdentifierType

public void setExternalIdentifierType(EntityExternalIdentifierTypeHistory.Builder externalIdentifierType)

setExternalId

public void setExternalId(String externalId)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

setId

public void setId(String id)