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

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences

All Implemented Interfaces:

Serializable, GloballyUnique, Versioned, ModelObjectBasic, ModelObjectComplete, EntityPrivacyPreferencesContract

public final class EntityPrivacyPreferences
extends AbstractDataTransferObject
implements EntityPrivacyPreferencesContract

See Also:

Serialized Form

Nested Class Summary

static class	EntityPrivacyPreferences.Builder A builder which can be used to construct EntityPrivacyPreferences instances.
static class	EntityPrivacyPreferences.Cache

Method Summary

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.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

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