| Interface | osid.mapping.MapSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description | 
                 This interface provides a means to capture results of a search.  | ||
| Method | getMaps | ||
| Description | 
                     Gets the map list resulting from a search.  | ||
| Return | osid.mapping.MapList | the map list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMapQueryInspector | ||
| Description | 
                     Gets the inspector for the query to examine the terms used in the search.  | ||
| Return | osid.mapping.MapQueryInspector | the map query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMapSearchResultsRecord | ||
| Description | 
                     Gets the map search results record corresponding to the 
                    given map search record   | ||
| Parameters | osid.type.Type | mapSearchRecordType | a map search record type | 
| Return | osid.mapping.records.MapSearchResultsRecord | the map search results 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. | |