Interface Person

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface Person extends OsidObject

A Person .

  • Method Details

    • getSalutation

      DisplayText getSalutation()
      Gets the title for this person (Mr., Dr., Ms.).
      Returns:
      the title
      Compliance:
      mandatory - This method must be implemented.

    • getGivenName

      DisplayText getGivenName()
      Gets the given name of this person.
      Returns:
      the given name
      Compliance:
      mandatory - This method must be implemented.

    • getPreferredName

      DisplayText getPreferredName()
      Gets the preferred forename or mononym of this person.
      Returns:
      the preferred name
      Compliance:
      mandatory - This method must be implemented.

    • getForenameAliases

      DisplayText[] getForenameAliases()
      Gets additional forenames this person is or was known by.
      Returns:
      forname aliases
      Compliance:
      mandatory - This method must be implemented.

    • getMiddleNames

      DisplayText[] getMiddleNames()
      Gets the middle names of this person.
      Returns:
      the middle names
      Compliance:
      mandatory - This method must be implemented.

    • getSurname

      DisplayText getSurname()
      Gets the surname of this person.
      Returns:
      the surname
      Compliance:
      mandatory - This method must be implemented.

    • getSurnameAliases

      DisplayText[] getSurnameAliases()
      Gets additional surnames this person is or was known by.
      Returns:
      the surname aliases
      Compliance:
      mandatory - This method must be implemented.

    • getGenerationQualifier

      DisplayText getGenerationQualifier()
      Gets the generation qualifier of this person.
      Returns:
      the generation qualifier
      Compliance:
      mandatory - This method must be implemented.

    • getQualificationSuffix

      DisplayText getQualificationSuffix()
      Gets the qualification suffix of this person (MD, Phd).
      Returns:
      the generation qualifier
      Compliance:
      mandatory - This method must be implemented.

    • hasBirthDate

      boolean hasBirthDate()
      Tests if a birth date is available.
      Returns:
      true if a birth date is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBirthDate

      DateTime getBirthDate()
      Gets the date of birth for this person.
      Returns:
      the date of birth
      Throws:
      IllegalStateException - hasBirthDate() is false
      Compliance:
      mandatory - This method must be implemented.

    • isDeceased

      boolean isDeceased()
      Tests if this person died.
      Returns:
      true if this person is dead, false if still kicking
      Compliance:
      mandatory - This method must be implemented.

    • getDeathDate

      DateTime getDeathDate()
      Gets the date of death for this person.
      Returns:
      the date of death
      Throws:
      IllegalStateException - isDead() is false
      Compliance:
      mandatory - This method must be implemented.

    • getInstitutionalIdentifier

      String getInstitutionalIdentifier()
      Gets the institutional identifier for this person.
      Returns:
      the institutional identifier
      Compliance:
      mandatory - This method must be implemented.

    • getPersonRecord

      PersonRecord getPersonRecord(Type personRecordType) throws OperationFailedException
      Gets the record corresponding to the given Person record Type .This method is used to retrieve an object implementing the requested record. The personRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(personRecordType) is true .
      Parameters:
      personRecordType - the type of person record to retrieve
      Returns:
      the person record
      Throws:
      NullArgumentException - personRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(personRecordType) is false
      Compliance:
      mandatory - This method must be implemented.