org.kuali.rice.kim.api.identity.affiliation

Class EntityAffiliation.Builder

java.lang.Object

org.kuali.rice.kim.api.identity.affiliation.EntityAffiliation.Builder

All Implemented Interfaces:

Serializable, Inactivatable, Defaultable, GloballyUnique, Identifiable, Versioned, ModelBuilder, EntityAffiliationContract

Enclosing class:

EntityAffiliation

public static final class EntityAffiliation.Builder
extends Object
implements Serializable, ModelBuilder, EntityAffiliationContract

A builder which can be used to construct EntityAffiliation instances. Enforces the constraints of the EntityAffiliationContract.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
EntityAffiliation	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static EntityAffiliation.Builder	create()
static EntityAffiliation.Builder	create(EntityAffiliationContract contract)
EntityAffiliationType.Builder	getAffiliationType() Gets this KimEntityAffiliation's type.
String	getCampusCode() Gets this KimEntityAffiliation's campus code.
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.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
boolean	isDefaultValue() The default value for this object.
void	setActive(boolean active)
void	setAffiliationType(EntityAffiliationType.Builder affiliationType)
void	setCampusCode(String campusCode)
void	setDefaultValue(boolean defaultValue)
void	setEntityId(String entityId)
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 EntityAffiliation.Builder create()

create

public static EntityAffiliation.Builder create(EntityAffiliationContract contract)

build

public EntityAffiliation 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: EntityAffiliationContract

Gets this id of the parent identity object.

Specified by:

getEntityId in interface EntityAffiliationContract

Returns:

the identity id for this EntityAddressContract

getAffiliationType

public EntityAffiliationType.Builder getAffiliationType()

Description copied from interface: EntityAffiliationContract

Gets this KimEntityAffiliation's type.

Specified by:

getAffiliationType in interface EntityAffiliationContract

Returns:

the type for this KimEntityAffiliation, or null if none has been assigned.

getCampusCode

public String getCampusCode()

Description copied from interface: EntityAffiliationContract

Gets this KimEntityAffiliation's campus code.

Specified by:

getCampusCode in interface EntityAffiliationContract

Returns:

the campus code for this KimEntityAffiliation, 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

isDefaultValue

public boolean isDefaultValue()

Description copied from interface: Defaultable

The default value for this object.

Specified by:

isDefaultValue in interface Defaultable

Returns:

the default value for this object

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)

setAffiliationType

public void setAffiliationType(EntityAffiliationType.Builder affiliationType)

setCampusCode

public void setCampusCode(String campusCode)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

setDefaultValue

public void setDefaultValue(boolean defaultValue)

setActive

public void setActive(boolean active)

setId

public void setId(String id)