org.kuali.rice.kim.api.identity.principal
Class PrincipalHistory.Builder

java.lang.Object
  org.kuali.rice.kim.api.identity.principal.PrincipalHistory.Builder

All Implemented Interfaces:

Serializable, Inactivatable, InactivatableFromTo, GloballyUnique, Historical, Versioned, ModelBuilder, PrincipalContract, PrincipalHistoryContract

Enclosing class:

PrincipalHistory

public static final class PrincipalHistory.Builder
extends Object
implements Serializable, ModelBuilder, PrincipalHistoryContract

A builder which can be used to construct PrincipalHistory instances. Enforces the constraints of the PrincipalContract.

See Also:

Serialized Form

Method Summary

PrincipalHistory	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static PrincipalHistory.Builder	create(PrincipalHistoryContract contract)
static PrincipalHistory.Builder	create(String principalName)
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 PrincipalContract's identity id.
Long	getHistoryId()
String	getObjectId() Return the globally unique object id of this object.
String	getPrincipalId() Gets this PrincipalContract's id.
String	getPrincipalName() Gets this PrincipalContract's name.
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	setActive(boolean active)
void	setActiveFromDate(org.joda.time.DateTime activeFromDate)
void	setActiveToDate(org.joda.time.DateTime activeToDate)
void	setEntityId(String entityId)
void	setHistoryId(Long historyId)
void	setObjectId(String objectId)
void	setPrincipalId(String principalId)
void	setPrincipalName(String principalName)
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 PrincipalHistory.Builder create(String principalName)

create

public static PrincipalHistory.Builder create(PrincipalHistoryContract contract)

build

public PrincipalHistory 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

getPrincipalId

public String getPrincipalId()

Description copied from interface: PrincipalContract

Gets this PrincipalContract's id.

Specified by:

getPrincipalId in interface PrincipalContract

Returns:

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

getPrincipalName

public String getPrincipalName()

Description copied from interface: PrincipalContract

Gets this PrincipalContract's name.

Specified by:

getPrincipalName in interface PrincipalContract

Returns:

the name for this PrincipalContract, this value cannot be null.

getEntityId

public String getEntityId()

Description copied from interface: PrincipalContract

Gets this PrincipalContract's identity id.

Specified by:

getEntityId in interface PrincipalContract

Returns:

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

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.

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

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

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)

setPrincipalId

public void setPrincipalId(String principalId)

setPrincipalName

public void setPrincipalName(String principalName)

setEntityId

public void setEntityId(String entityId)

setActive

public void setActive(boolean active)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)