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

Interface EntityNameContract

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:
EntityName, EntityName.Builder
public interface EntityNameContract 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 name information associated with an Entity.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Field Details

  • Method Details

    • getEntityId

      String getEntityId()
      Gets this
      invalid reference 
      Entity
      's id.
      Returns:
      the id for this EntityNameContract, or null if none has been assigned.

    • getNameType

      CodedAttributeContract getNameType()
      Gets this EntityNameContract's TypeContract.
      Returns:
      the type for this EntityNameContract, or null if none has been assigned.

    • getFirstName

      String getFirstName()
      Gets this EntityNameContract's first name.
      Returns:
      the first name for this EntityNameContract, or null if none has been assigned.

    • getFirstNameUnmasked

      String getFirstNameUnmasked()
      Gets this EntityNameContract's unmasked first name.
      Returns:
      the unmasked first name for this EntityNameContract, or null if none has been assigned.

    • getMiddleName

      String getMiddleName()
      Gets this EntityNameContract's middle name.
      Returns:
      the middle name for this EntityNameContract, or null if none has been assigned.

    • getMiddleNameUnmasked

      String getMiddleNameUnmasked()
      Gets this EntityNameContract's unmasked middle name.
      Returns:
      the unmasked middle name for this EntityNameContract, or null if none has been assigned.

    • getLastName

      String getLastName()
      Gets this EntityNameContract's last name.
      Returns:
      the last name for this EntityNameContract, or null if none has been assigned.

    • getLastNameUnmasked

      String getLastNameUnmasked()
      Gets this EntityNameContract's unmasked last name.
      Returns:
      the unmasked last name for this EntityNameContract, or null if none has been assigned.

    • getNamePrefix

      String getNamePrefix()
      Gets this EntityNameContract's name prefix. Corresponds to PESC NamePrefix.
      Returns:
      the name prefix for this EntityNameContract, or null if none has been assigned.

    • getNamePrefixUnmasked

      String getNamePrefixUnmasked()
      Gets this EntityNameContract's unmasked name prefix. Corresponds to PESC NamePrefix.
      Returns:
      the unmasked name prefix for this EntityNameContract, or null if none has been assigned.

    • getNameTitle

      String getNameTitle()
      Gets this EntityNameContract's name title. Corresponds to PESC NameTitle.
      Returns:
      the name title for this EntityNameContract, or null if none has been assigned.

    • getNameTitleUnmasked

      String getNameTitleUnmasked()
      Gets this EntityNameContract's unmasked name title. Corresponds to PESC NameTitle.
      Returns:
      the unmasked name title for this EntityNameContract, or null if none has been assigned.

    • getNameSuffix

      String getNameSuffix()
      Gets this EntityNameContract's suffix. Corresponds to PESC NameSuffix.
      Returns:
      the suffix for this EntityNameContract, or null if none has been assigned.

    • getNameSuffixUnmasked

      String getNameSuffixUnmasked()
      Gets this EntityNameContract's unmasked suffix. Corresponds to PESC NameSuffix.
      Returns:
      the unmasked suffix for this EntityNameContract, or null if none has been assigned.

    • getCompositeName

      String getCompositeName()
      Return the entire name as the person or system wants it displayed. Corresponds to PESC CompositeName.
      Returns:
      the complete name in the format of "lastName, firstName middleName"

    • getCompositeNameUnmasked

      String getCompositeNameUnmasked()
      Gets this EntityNameContract's unmasked formatted name. Corresponds to PESC CompositeName.
      Returns:
      the complete name in the format of "lastName, firstName middleName"

    • getNoteMessage

      String getNoteMessage()
      Get the note associated with this EntityNameContract Corresponds to PESC NoteMessage
      Returns:
      the message associated with this EntityName

    • getNameChangedDate

      org.joda.time.DateTime getNameChangedDate()
      Get the name change date EntityNameContract Corresponds to PESC name changed date
      Returns:
      the name change date of this EntityName

    • isSuppressName

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