OSID - osid.mapping.path.SpeedZoneSearchSession Service Interface Definition

Interface	osid.mapping.path.SpeedZoneSearchSession
Implements	`osid.mapping.path.SpeedZoneQuerySession`
Description	This session provides methods for searching among `SpeedZone` objects. The search query is constructed using the `SpeedZoneQuery.` `getSpeedZonesByQuery()` is the basic search method and returns a list of `SpeedZones.` A more advanced search may be performed with `getSpeedZonesBySearch().` It accepts a `SpeedZoneSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSpeedZonesBySearch()` returns a `SpeedZoneSearchResults` that can be used to access the resulting `SpeedZoneList` or be used to perform a search within the result set through `SpeedZoneSearch.` This session defines views that offer differing behaviors for searching. federated map view: searches include speed zones in maps of which this map is an ancestor in the map hierarchy isolated map view: searches are restricted to speed zones in this map SpeedZones may have a query record indicated by their respective record types. The query record is accessed via the `SpeedZoneQuery.`
Method	getSpeedZoneSearch
Description	Gets a speed zone search.
Return	`osid.mapping.path.SpeedZoneSearch`		the speed zone search
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneSearchOrder
Description	Gets a speed zone search order. The `SpeedZoneSearchOrder` is supplied to a `SpeedZoneSearch` to specify the ordering of results.
Return	`osid.mapping.path.SpeedZoneSearchOrder`		the speed zone search order
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZonesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.path.SpeedZoneQuery`	`speedZoneQuery`	the speed zone query
Parameters	`osid.mapping.path.SpeedZoneSearch`	`speedZoneSearch`	the speed zone search
Return	`osid.mapping.path.SpeedZoneSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`speedZoneQuery` or `speed zoneSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`speedZoneQuery` or `speed zoneSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneQueryFromInspector
Description	Gets a speed zone query from an inspector. The inspector is available from a `SpeedZoneSearchResults.`
Parameters	`osid.mapping.path.SpeedZoneQueryInspector`	`speedZoneQueryInspector`	a speed zone query inspector
Return	`osid.mapping.path.SpeedZoneQuery`		the speed zone query
Errors	NULL_ARGUMENT		`speedZoneQueryInspector` is `null`
Errors	UNSUPPORTED		`speedZoneQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.