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

Interface EntityPhoneContract

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:
EntityPhone, EntityPhone.Builder
public interface EntityPhoneContract 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 is a contract for EntityPhone and represents the phone information of 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 EntityPhoneContract

    • getEntityTypeCode

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

    • getPhoneType

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

    • getPhoneNumber

      String getPhoneNumber()
      Gets this EntityPhone's phone number.
      Returns:
      the phone number for this EntityPhone, or null if none has been assigned.

    • getExtensionNumber

      String getExtensionNumber()
      Gets this EntityPhone's extension number.
      Returns:
      the extension number for this EntityPhone, or null if none has been assigned.

    • getCountryCode

      String getCountryCode()
      Gets this EntityPhone's country code.
      Returns:
      the country code for this EntityPhone, or null if none has been assigned.

    • getPhoneNumberUnmasked

      String getPhoneNumberUnmasked()
      Gets this EntityPhone's unmasked phone number.
      Returns:
      the unmasked phone number for this EntityPhone, or null if none has been assigned.

    • getExtensionNumberUnmasked

      String getExtensionNumberUnmasked()
      Gets this EntityPhone's unmasked extension number.
      Returns:
      the unmasked extension number for this EntityPhone, or null if none has been assigned.

    • getCountryCodeUnmasked

      String getCountryCodeUnmasked()
      Gets this EntityPhone's unmasked country code.
      Returns:
      the unmasked country code for this EntityPhone, or null if none has been assigned.

    • getFormattedPhoneNumber

      String getFormattedPhoneNumber()
      Gets this EntityPhone's formatted phone number.
      Returns:
      the formatted phone number for this EntityPhone, or null if none has been assigned.

    • getFormattedPhoneNumberUnmasked

      String getFormattedPhoneNumberUnmasked()
      Gets this EntityPhone's unmasked formatted phone number.
      Returns:
      the unmasked formatted phone number for this EntityPhone, or null if none has been assigned.

    • isSuppressPhone

      boolean isSuppressPhone()
      Returns a boolean value that determines if phone fields should be suppressed.
      Returns:
      boolean value that determines if phone should be suppressed.