org.kuali.rice.kim.api.identity.citizenship

Class EntityCitizenship.Builder

java.lang.Object

org.kuali.rice.kim.api.identity.citizenship.EntityCitizenship.Builder

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelBuilder, EntityCitizenshipContract

Enclosing class:

EntityCitizenship

public static final class EntityCitizenship.Builder
extends Object
implements Serializable, ModelBuilder, EntityCitizenshipContract

A builder which can be used to construct EntityCitizenship instances. Enforces the constraints of the EntityCitizenshipContract.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
EntityCitizenship	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static EntityCitizenship.Builder	create()
static EntityCitizenship.Builder	create(EntityCitizenshipContract contract)
String	getCountryCode() Gets this EntityCitizenshipContract's country code.
org.joda.time.DateTime	getEndDate() Gets this EntityCitizenshipContract's end date.
String	getEntityId() Gets this id of the parent identity object.
String	getId() The unique identifier for an object.
String	getObjectId() Return the globally unique object id of this object.
org.joda.time.DateTime	getStartDate() Gets this EntityCitizenshipContract's start date.
CodedAttribute.Builder	getStatus() Gets this EntityCitizenshipContract's citizenship status object.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
void	setActive(boolean active)
void	setCountryCode(String countryCode)
void	setEndDate(org.joda.time.DateTime endDate)
void	setEntityId(String entityId)
void	setId(String id)
void	setObjectId(String objectId)
void	setStartDate(org.joda.time.DateTime startDate)
void	setStatus(CodedAttribute.Builder status)
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 EntityCitizenship.Builder create()

create

public static EntityCitizenship.Builder create(EntityCitizenshipContract contract)

build

public EntityCitizenship 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: EntityCitizenshipContract

Gets this id of the parent identity object.

Specified by:

getEntityId in interface EntityCitizenshipContract

Returns:

the identity id for this EntityCitizenshipContract

getStatus

public CodedAttribute.Builder getStatus()

Description copied from interface: EntityCitizenshipContract

Gets this EntityCitizenshipContract's citizenship status object.

Specified by:

getStatus in interface EntityCitizenshipContract

Returns:

the Type object of citizenship status for this EntityCitizenshipContract, or null if none has been assigned.

getCountryCode

public String getCountryCode()

Description copied from interface: EntityCitizenshipContract

Gets this EntityCitizenshipContract's country code.

Specified by:

getCountryCode in interface EntityCitizenshipContract

Returns:

the country code for this EntityCitizenshipContract, or null if none has been assigned.

getStartDate

public org.joda.time.DateTime getStartDate()

Description copied from interface: EntityCitizenshipContract

Gets this EntityCitizenshipContract's start date.

Specified by:

getStartDate in interface EntityCitizenshipContract

Returns:

the start date for this EntityCitizenshipContract, or null if none has been assigned.

getEndDate

public org.joda.time.DateTime getEndDate()

Description copied from interface: EntityCitizenshipContract

Gets this EntityCitizenshipContract's end date.

Specified by:

getEndDate in interface EntityCitizenshipContract

Returns:

the end date for this EntityCitizenshipContract, 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

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.

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)

setStatus

public void setStatus(CodedAttribute.Builder status)

setCountryCode

public void setCountryCode(String countryCode)

setStartDate

public void setStartDate(org.joda.time.DateTime startDate)

setEndDate

public void setEndDate(org.joda.time.DateTime endDate)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

setActive

public void setActive(boolean active)

setId

public void setId(String id)