OSID Specifications
personnel package
Version 3.0.0
personnel package
Version 3.0.0
| Interface | osid.personnel.PersonSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Used By | osid.personnel.AppointmentSearchOrder | ||
osid.personnel.PersonSearchSession | |||
osid.personnel.PersonSmartRealmSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderBySalutation | ||
| Description |
Specifies a preference for ordering the result set by the salutation. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByGivenName | ||
| Description |
Specifies a preference for ordering the result set by the given name. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPreferredName | ||
| Description |
Specifies a preference for ordering the result set by the preferred name. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySurname | ||
| Description |
Specifies a preference for ordering the result set by the surname. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByGenerationQualifier | ||
| Description |
Specifies a preference for ordering the result set by the generation qualifier. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByQualificationSuffix | ||
| Description |
Specifies a preference for ordering the result set by the qualification suffix. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBirthDate | ||
| Description |
Specifies a preference for ordering the result set by the birth date. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDeathDate | ||
| Description |
Specifies a preference for ordering the result set by the death date. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByInstitutionalIdentifier | ||
| Description |
Specifies a preference for ordering the result set by the institutional identifier. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPersonSearchOrderRecord | ||
| Description |
Gets the person search order record corresponding to
the given person record | ||
| Parameters | osid.type.Type | personRecordType | a person record type |
| Return | osid.personnel.records.PersonSearchOrderRecord | the person search order record | |
| Errors | NULL_ARGUMENT | personRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(personRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |