OSID - osid.mapping.MapSearchSession Service Interface Definition

Interface	osid.mapping.MapSearchSession
Implements	`osid.mapping.MapQuerySession`
Description	This session provides methods for searching among `Map` objects. The search query is constructed using the `MapQuery.` `getMapsByQuery()` is the basic search method and returns a list of `Maps.` A more advanced search may be performed with `getMapsBySearch().` It accepts a `MapSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getMapsBySearch()` returns a `MapSearchResults` that can be used to access the resulting `MapList` or be used to perform a search within the result set through `MapSearch.` Maps may have a query record indicated by their respective record types. The query record is accessed via the `MapQuery.`
Method	getMapSearch
Description	Gets a map search.
Return	`osid.mapping.MapSearch`		the map search
Compliance	`mandatory`		This method must be implemented.
Method	getMapSearchOrder
Description	Gets a map search order. The `MapSearchOrder` is supplied to a `MapSearch` to specify the ordering of results.
Return	`osid.mapping.MapSearchOrder`		the map search order
Compliance	`mandatory`		This method must be implemented.
Method	getMapsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.MapQuery`	`mapQuery`	the map query
Parameters	`osid.mapping.MapSearch`	`mapSearch`	the map search
Return	`osid.mapping.MapSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`mapQuery` or `mapSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`mapQuery` or `mapSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getMapQueryFromInspector
Description	Gets a map query from an inspector. The inspector is available from a `MapSearchResults.`
Parameters	`osid.mapping.MapQueryInspector`	`mapQueryInspector`	a map query inspector
Return	`osid.mapping.MapQuery`		the map query
Errors	NULL_ARGUMENT		`mapQueryInspector` is `null`
Errors	UNSUPPORTED		`mapQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.