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

Interface EntityEmailContract

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

  • 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.