| Interface | osid.mapping.LocationSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getLocations | ||
| Description |
Gets the location list resulting from a search. | ||
| Return | osid.mapping.LocationList | the location list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.mapping.LocationQueryInspector | the location query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationSearchResultsRecord | ||
| Description |
Gets the record corresponding to the given location
search record | ||
| Parameters | osid.type.Type | locationSearchRecordType | a location search record type |
| Return | osid.mapping.records.LocationSearchResultsRecord | the location search results record | |
| Errors | NULL_ARGUMENT | locationSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(locationSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |