public interface Person extends OsidObject
A Person.
Modifier and Type | Method and Description |
---|---|
DateTime |
getBirthDate()
Gets the date of birth for this person.
|
DateTime |
getDeathDate()
Gets the date of death for this person.
|
DisplayText[] |
getForenameAliases()
Gets additional forenames this person is or was known by.
|
DisplayText |
getGenerationQualifier()
Gets the generation qualifier of this person.
|
DisplayText |
getGivenName()
Gets the given name of this person.
|
java.lang.String |
getInstitutionalIdentifier()
Gets the institutional identifier for this person.
|
DisplayText[] |
getMiddleNames()
Gets the middle names of this person.
|
PersonRecord |
getPersonRecord(Type personRecordType)
Gets the record corresponding to the given
Person
record Type. |
DisplayText |
getPreferredName()
Gets the preferred forename or mononym of this person.
|
DisplayText |
getQualificationSuffix()
Gets the qualification suffix of this person (MD, Phd).
|
DisplayText |
getSalutation()
Gets the title for this person (Mr., Dr., Ms.).
|
DisplayText |
getSurname()
Gets the surname of this person.
|
DisplayText[] |
getSurnameAliases()
Gets additional surnames this person is or was known by.
|
boolean |
hasBirthDate()
Tests if a birth date is available.
|
boolean |
isDeceased()
Tests if this person died.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DisplayText getSalutation()
mandatory
- This method must be implemented. DisplayText getGivenName()
mandatory
- This method must be implemented. DisplayText getPreferredName()
mandatory
- This method must be implemented. DisplayText[] getForenameAliases()
mandatory
- This method must be implemented. DisplayText[] getMiddleNames()
mandatory
- This method must be implemented. DisplayText getSurname()
mandatory
- This method must be implemented. DisplayText[] getSurnameAliases()
mandatory
- This method must be implemented. DisplayText getGenerationQualifier()
mandatory
- This method must be implemented. DisplayText getQualificationSuffix()
mandatory
- This method must be implemented. boolean hasBirthDate()
true
if a birth date is available, false
otherwisemandatory
- This method must be implemented. DateTime getBirthDate()
IllegalStateException
- hasBirthDate()
is false
mandatory
- This method must be implemented. boolean isDeceased()
true
if this person is dead, false
if still kickingmandatory
- This method must be implemented. DateTime getDeathDate()
IllegalStateException
- isDead()
is
false
mandatory
- This method must be implemented. java.lang.String getInstitutionalIdentifier()
mandatory
- This method must be implemented. PersonRecord getPersonRecord(Type personRecordType) throws OperationFailedException
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
.personRecordType
- the type of person record to retrieveNullArgumentException
- personRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(personRecordType)
is false
mandatory
- This method must be implemented.