OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
personnel package
Version 3.0.0
Release Candidate Preview
| Interface | osid.personnel.RealmSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getRealms | ||
| Description |
Gets the realm list resulting from a search. | ||
| Return | osid.personnel.RealmList | the realm list | |
| Errors | ILLEGAL_STATE | the list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRealmQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.personnel.RealmQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRealmSearchResultsRecord | ||
| Description |
Gets the record corresponding to the given realm search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | realmSearchRecordType | a realm search record type |
| Return | osid.personnel.records.RealmSearchResultsRecord | the realm search results record | |
| Errors | NULL_ARGUMENT | realmSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(realmSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |