Interface | osid.personnel.PersonSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getPersons | ||
Description |
Gets the person list resulting from a search. | ||
Return | osid.personnel.PersonList | the person list | |
Errors | ILLEGAL_STATE | the list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getPersonQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.personnel.PersonQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getPersonSearchResultsRecord | ||
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.PersonSearchResultsRecord | the person search results 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. |