org.kuali.rice.kim.api.identity.privacy
Class EntityPrivacyPreferences.Builder

java.lang.Object
  org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences.Builder

All Implemented Interfaces:

Serializable, GloballyUnique, Versioned, ModelBuilder, EntityPrivacyPreferencesContract

Enclosing class:

EntityPrivacyPreferences

public static final class EntityPrivacyPreferences.Builder
extends Object
implements Serializable, ModelBuilder, EntityPrivacyPreferencesContract

A builder which can be used to construct EntityPrivacyPreferences instances. Enforces the constraints of the EntityPrivacyPreferencesContract.

See Also:

Serialized Form

Method Summary

EntityPrivacyPreferences	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static EntityPrivacyPreferences.Builder	create(EntityPrivacyPreferencesContract contract)
static EntityPrivacyPreferences.Builder	create(String entityId)
String	getEntityId() Gets this id of the parent identity object.
String	getObjectId() Return the globally unique object id of this object.
Long	getVersionNumber() Returns the version number for this object.
boolean	isSuppressAddress() This is value designating if Entity Address should be suppressed.
boolean	isSuppressEmail() This is value designating if Entity Email should be suppressed.
boolean	isSuppressName() This is value designating if Entity Name should be suppressed.
boolean	isSuppressPersonal() This is value designating if Entity Personal information should be suppressed.
boolean	isSuppressPhone() This is value designating if Entity Phone should be suppressed.
void	setEntityId(String entityId)
void	setObjectId(String objectId)
void	setSuppressAddress(boolean suppressAddress)
void	setSuppressEmail(boolean suppressEmail)
void	setSuppressName(boolean suppressName)
void	setSuppressPersonal(boolean suppressPersonal)
void	setSuppressPhone(boolean suppressPhone)
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 EntityPrivacyPreferences.Builder create(String entityId)

create

public static EntityPrivacyPreferences.Builder create(EntityPrivacyPreferencesContract contract)

build

public EntityPrivacyPreferences 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: EntityPrivacyPreferencesContract

Gets this id of the parent identity object.

Specified by:

getEntityId in interface EntityPrivacyPreferencesContract

Returns:

the identity id for this EntityPrivacyPreferencesContract

isSuppressName

public boolean isSuppressName()

Description copied from interface: EntityPrivacyPreferencesContract

This is value designating if Entity Name should be suppressed.

This is a boolean value that shows if identity names should be suppressed or not.

Specified by:

isSuppressName in interface EntityPrivacyPreferencesContract

Returns:

suppressName

isSuppressAddress

public boolean isSuppressAddress()

Description copied from interface: EntityPrivacyPreferencesContract

This is value designating if Entity Address should be suppressed.

This is a boolean value that shows if identity addresses should be suppressed or not.

Specified by:

isSuppressAddress in interface EntityPrivacyPreferencesContract

Returns:

suppressAddress

isSuppressEmail

public boolean isSuppressEmail()

Description copied from interface: EntityPrivacyPreferencesContract

This is value designating if Entity Email should be suppressed.

This is a boolean value that shows if identity emails should be suppressed or not.

Specified by:

isSuppressEmail in interface EntityPrivacyPreferencesContract

Returns:

suppressEmail

isSuppressPhone

public boolean isSuppressPhone()

Description copied from interface: EntityPrivacyPreferencesContract

This is value designating if Entity Phone should be suppressed.

This is a boolean value that shows if identity phones should be suppressed or not.

Specified by:

isSuppressPhone in interface EntityPrivacyPreferencesContract

Returns:

suppressPhone

isSuppressPersonal

public boolean isSuppressPersonal()

Description copied from interface: EntityPrivacyPreferencesContract

This is value designating if Entity Personal information should be suppressed.

This is a boolean value that shows if identity personal information should be suppressed or not.

Specified by:

isSuppressPersonal in interface EntityPrivacyPreferencesContract

Returns:

suppressPersonal

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

setEntityId

public void setEntityId(String entityId)

setSuppressName

public void setSuppressName(boolean suppressName)

setSuppressAddress

public void setSuppressAddress(boolean suppressAddress)

setSuppressEmail

public void setSuppressEmail(boolean suppressEmail)

setSuppressPhone

public void setSuppressPhone(boolean suppressPhone)

setSuppressPersonal

public void setSuppressPersonal(boolean suppressPersonal)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)