OSID - osid.mapping.LocationSearchSession Service Interface Definition

Interface	osid.mapping.LocationSearchSession
Implements	`osid.mapping.LocationQuerySession`
Description	This session provides methods for searching among `Location` objects. The search query is constructed using the `LocationQuery.` `getLocationsByQuery()` is the basic search method and returns a list of `Locations.` A more advanced search may be performed with `getLocationsBySearch().` It accepts a `LocationSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getLocationsBySearch()` returns a `LocationSearchResults` that can be used to access the resulting `LocationList` or be used to perform a search within the result set through `LocationSearch.` This session defines views that offer differing behaviors for searching. federated map view: searches include locations in maps of which this map is an ancestor in the map hierarchy isolated map view: searches are restricted to locations in this map Locations may have a query record indicated by their respective record types. The query record is accessed via the `LocationQuery.`
Method	getLocationSearch
Description	Gets a location search.
Return	`osid.mapping.LocationSearch`		the location search
Compliance	`mandatory`		This method must be implemented.
Method	getLocationSearchOrder
Description	Gets a location search order. The `LocationSearchOrder` is supplied to a `LocationSearch` to specify the ordering of results.
Return	`osid.mapping.LocationSearchOrder`		the location search order
Compliance	`mandatory`		This method must be implemented.
Method	getLocationsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.LocationQuery`	`locationQuery`	the location query
Parameters	`osid.mapping.LocationSearch`	`locationSearch`	the location search
Return	`osid.mapping.LocationSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`locationQuery` or `locationSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`locationQuery` or `locationSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getLocationQueryFromInspector
Description	Gets a location query from an inspector. The inspector is available from a `LocationSearchResults.`
Parameters	`osid.mapping.LocationQueryInspector`	`locationQueryInspector`	a location query inspector
Return	`osid.mapping.LocationQuery`		the location query
Errors	NULL_ARGUMENT		`locationQueryInspector` is `null`
Errors	UNSUPPORTED		`locationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.