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

Interface EntityEmailContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.Defaultable, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
EntityEmail, EntityEmail.Builder
public interface EntityEmailContract extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Defaultable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Identifiable
This contract represents the email information associated with an Entity.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEmailAddress()
    Gets this EntityEmail's email address.
    String
    getEmailAddressUnmasked()
    Gets this EntityEmail's unmasked email address.
    CodedAttributeContract
    getEmailType()
    Gets this EntityEmail's type code.
    String
    getEntityId()
    Gets this id of the parent identity object.
    String
    getEntityTypeCode()
    Gets this entityTypeCode of the EntityEmailContract's object.
    boolean
    isSuppressEmail()
    Returns a boolean value that determines if email fields should be suppressed.

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

    isDefaultValue

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

    getObjectId

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

    getId

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

    isActive

    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 EntityEmailContract

    • getEntityTypeCode

      String getEntityTypeCode()
      Gets this entityTypeCode of the EntityEmailContract's object.
      Returns:
      the identity type code for this EntityEmailContract

    • getEmailType

      CodedAttributeContract getEmailType()
      Gets this EntityEmail's type code.
      Returns:
      the type code for this EntityEmail, or null if none has been assigned.

    • getEmailAddress

      String getEmailAddress()
      Gets this EntityEmail's email address.
      Returns:
      the email address for this EntityEmail, or null if none has been assigned.

    • getEmailAddressUnmasked

      String getEmailAddressUnmasked()
      Gets this EntityEmail's unmasked email address.
      Returns:
      the unmasked email address for this EntityEmail, or null if none has been assigned.

    • isSuppressEmail

      boolean isSuppressEmail()
      Returns a boolean value that determines if email fields should be suppressed.
      Returns:
      boolean value that determines if email should be suppressed.