Package org.kuali.rice.kim.api.identity.privacy

Interface EntityPrivacyPreferencesContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
EntityPrivacyPreferences, EntityPrivacyPreferences.Builder
public interface EntityPrivacyPreferencesContract extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.GloballyUnique
This is a contract for EntityPrivacyPreferences. Privacy preferences are used to hide/suppress certain contact information.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEntityId()
    Gets this id of the parent identity 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 interface org.kuali.rice.core.api.mo.common.GloballyUnique

    getObjectId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

    getVersionNumber

  • Method Details

    • getEntityId

      String getEntityId()
      Gets this id of the parent identity object.
      Returns:
      the identity id for this EntityPrivacyPreferencesContract

    • isSuppressName

      boolean isSuppressName()
      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.

      Returns:
      suppressName

    • isSuppressAddress

      boolean isSuppressAddress()
      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.

      Returns:
      suppressAddress

    • isSuppressEmail

      boolean isSuppressEmail()
      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.

      Returns:
      suppressEmail

    • isSuppressPhone

      boolean isSuppressPhone()
      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.

      Returns:
      suppressPhone

    • isSuppressPersonal

      boolean isSuppressPersonal()
      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.

      Returns:
      suppressPersonal