Interface | osid.mapping.MapSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing map searches. | ||
Method | searchAmongMaps | ||
Description |
Execute this search among the given list of maps. | ||
Parameters | osid.id.IdList | mapIds | list of maps |
Errors | NULL_ARGUMENT | mapIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderMapResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.mapping.MapSearchOrder | mapSearchOrder | map search order |
Errors | NULL_ARGUMENT | mapSearchOrder is null | |
UNSUPPORTED | mapSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMapSearchRecord | ||
Description |
Gets the map search record corresponding to the given
map search record | ||
Parameters | osid.type.Type | mapSearchRecordType | a map search record type |
Return | osid.mapping.records.MapSearchRecord | the map search record | |
Errors | NULL_ARGUMENT | mapSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(mapSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |