Interface | osid.personnel.PersonSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing person searches. | ||
Method | searchAmongPersons | ||
Description |
Execute this search among the given list of persons. | ||
Parameters | osid.id.IdList | personIds | list of persons |
Errors | NULL_ARGUMENT | personIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderPersonResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.personnel.PersonSearchOrder | personSearchOrder | person search order |
Errors | NULL_ARGUMENT | personSearchOrder is null | |
UNSUPPORTED | personSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPersonSearchRecord | ||
Description |
Gets the record corresponding to the given person
search record | ||
Parameters | osid.type.Type | personSearchRecordType | a person search record type |
Return | osid.personnel.records.PersonSearchRecord | the person search record | |
Errors | NULL_ARGUMENT | personSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(personSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |