OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.Person
Implementsosid.OsidObject
Description

A Person.

MethodgetSalutation
Description

Gets the title for this person (Mr., Dr., Ms.).

Returnosid.locale.DisplayTextthe title
CompliancemandatoryThis method must be implemented.
MethodgetGivenName
Description

Gets the given name of this person.

Returnosid.locale.DisplayTextthe given name
CompliancemandatoryThis method must be implemented.
MethodgetPreferredName
Description

Gets the preferred forename or mononym of this person.

Returnosid.locale.DisplayTextthe preferred name
CompliancemandatoryThis method must be implemented.
MethodgetForenameAliases
Description

Gets additional forenames this person is or was known by.

Returnosid.locale.DisplayText[]forname aliases
CompliancemandatoryThis method must be implemented.
MethodgetMiddleNames
Description

Gets the middle names of this person.

Returnosid.locale.DisplayText[]the middle names
CompliancemandatoryThis method must be implemented.
MethodgetSurname
Description

Gets the surname of this person.

Returnosid.locale.DisplayTextthe surname
CompliancemandatoryThis method must be implemented.
MethodgetSurnameAliases
Description

Gets additional surnames this person is or was known by.

Returnosid.locale.DisplayText[]the surname aliases
CompliancemandatoryThis method must be implemented.
MethodgetGenerationQualifier
Description

Gets the generation qualifier of this person.

Returnosid.locale.DisplayTextthe generation qualifier
CompliancemandatoryThis method must be implemented.
MethodgetQualificationSuffix
Description

Gets the qualification suffix of this person (MD, Phd).

Returnosid.locale.DisplayTextthe generation qualifier
CompliancemandatoryThis method must be implemented.
MethodhasBirthDate
Description

Tests if a birth date is available.

Returnboolean true if a birth date is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBirthDate
Description

Gets the date of birth for this person.

Returnosid.calendaring.DateTimethe date of birth
ErrorsILLEGAL_STATE hasBirthDate() is false
CompliancemandatoryThis method must be implemented.
MethodisDeceased
Description

Tests if this person died.

Returnboolean true if this person is dead, false if still kicking
CompliancemandatoryThis method must be implemented.
MethodgetDeathDate
Description

Gets the date of death for this person.

Returnosid.calendaring.DateTimethe date of death
ErrorsILLEGAL_STATE isDead() is false
CompliancemandatoryThis method must be implemented.
MethodgetInstitutionalIdentifier
Description

Gets the institutional identifier for this person.

Returnstringthe institutional identifier
CompliancemandatoryThis method must be implemented.
MethodgetPersonRecord
Description

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 .

Parametersosid.type.TypepersonRecordTypethe type of person record to retrieve
Returnosid.personnel.records.PersonRecordthe person record
ErrorsNULL_ARGUMENT personRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(personRecordType) is false
CompliancemandatoryThis method must be implemented.