OSID Logo
OSID Specifications
personnel package
Version 3.1.0
Interfaceosid.personnel.Person
Implementsosid.OsidObject
Used Byosid.personnel.Appointment
osid.personnel.PersonAdminSession
osid.personnel.PersonList
osid.personnel.PersonLookupSession
Description

A Person.

MethodgetSalutation
Description

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

Returnosid.locale.DisplayText the title
Compliancemandatory This method must be implemented.
MethodgetGivenName
Description

Gets the given name of this person.

Returnosid.locale.DisplayText the given name
Compliancemandatory This method must be implemented.
MethodgetPreferredName
Description

Gets the preferred forename or mononym of this person.

Returnosid.locale.DisplayText the preferred name
Compliancemandatory This method must be implemented.
MethodgetForenameAliases
Description

Gets additional forenames this person is or was known by.

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

Gets the middle names of this person.

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

Gets the surname of this person.

Returnosid.locale.DisplayText the surname
Compliancemandatory This method must be implemented.
MethodgetSurnameAliases
Description

Gets additional surnames this person is or was known by.

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

Gets the generation qualifier of this person.

Returnosid.locale.DisplayText the generation qualifier
Compliancemandatory This method must be implemented.
MethodgetQualificationSuffix
Description

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

Returnosid.locale.DisplayText the generation qualifier
Compliancemandatory This method must be implemented.
MethodhasBirthDate
Description

Tests if a birth date is available.

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

Gets the date of birth for this person.

Returnosid.calendaring.DateTime the date of birth
ErrorsILLEGAL_STATE hasBirthDate() is false
Compliancemandatory This method must be implemented.
MethodisDeceased
Description

Tests if this person died.

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

Gets the date of death for this person.

Returnosid.calendaring.DateTime the date of death
ErrorsILLEGAL_STATE isDead() is false
Compliancemandatory This method must be implemented.
MethodgetInstitutionalIdentifier
Description

Gets the institutional identifier for this person.

Returnstring the institutional identifier
Compliancemandatory This 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.TypepersonRecordType the type of person record to retrieve
Returnosid.personnel.records.PersonRecord the person record
ErrorsNULL_ARGUMENT personRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(personRecordType) is false
Compliancemandatory This method must be implemented.