| Interface | osid.mapping.LocationSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description | 
                 The search interface for governing location searches.  | ||
| Method | searchAmongLocations | ||
| Description | 
                     Execute this search among the given list of locations.  | ||
| Parameters | osid.id.IdList | locationIds | list of locations | 
| Errors | NULL_ARGUMENT |  locationIds  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderLocationResults | ||
| Description | 
                     Specify an ordering to the search results.  | ||
| Parameters | osid.mapping.LocationSearchOrder | locationSearchOrder | location search order | 
| Errors | NULL_ARGUMENT |  locationSearchOrder  is  null   |                 |
| UNSUPPORTED |  locationSearchOrder  is not of this service  |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getLocationSearchRecord | ||
| 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.LocationSearchRecord | the location search 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. | |