OSID - osid.mapping.path.rules.SpeedZoneEnablerSearchSession Service Interface Definition

Interface	osid.mapping.path.rules.SpeedZoneEnablerSearchSession
Implements	`osid.mapping.path.rules.SpeedZoneEnablerQuerySession`
Used By	`osid.mapping.path.rules.MappingPathRulesManager`
Used By	`osid.mapping.path.rules.MappingPathRulesProxyManager`
Description	This session provides methods for searching among `SpeedZoneEnabler` objects. The search query is constructed using the `SpeedZoneEnableryQuery` . `getSpeedZoneEnablersByQuery()` is the basic search method and returns a list of `SpeedZoneEnablers` . A more advanced search may be performed with `getSpeedZoneEnablersBySearch()` . It accepts a `SpeedZoneEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as mapping. `getSpeedZoneEnablersBySearch()` returns a `SpeedZoneEnablerSearchResults` that can be used to access the resulting `SpeedZoneEnablerList` or be used to perform a search within the result set through `SpeedZoneEnablerSearch` . This session defines views that offer differing behaviors for searching. federated map view: searches include speed zone enablers in map of which this map matchmaker is an ancestor in the map hierarchy isolated map view: searches are restricted to speed zone enablers in this map `SpeedZoneEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `SpeedZoneEnablerQuery` .
Method	getSpeedZoneEnablerSearch
Description	Gets a speed zone enabler search.
Return	`osid.mapping.path.rules.SpeedZoneEnablerSearch`		the speed zone enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablerSearchOrder
Description	Gets a speed zone enabler search order. The `SpeedZoneEnablerSearchOrder` is supplied to a `SpeedZoneEnablerSearch` to specify the ordering of results.
Return	`osid.mapping.path.rules.SpeedZoneEnablerSearchOrder`		the speed zone enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.path.rules.SpeedZoneEnablerQuery`	`speedZoneEnablerQuery`	the speed zone enabler query
Parameters	`osid.mapping.path.rules.SpeedZoneEnablerSearch`	`speedZoneEnablerSearch`	the speed zone enabler search
Return	`osid.mapping.path.rules.SpeedZoneEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`speedZoneEnablerQuery` or `speed zoneEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`speedZoneEnablerQuery` or `speed zoneEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablerQueryFromInspector
Description	Gets a speed zone enabler query from an inspector. The inspector is available from a `SpeedZoneEnablerSearchResults` .
Parameters	`osid.mapping.path.rules.SpeedZoneEnablerQueryInspector`	`speedZoneEnablerQueryInspector`	a speed zone enabler query inspector
Return	`osid.mapping.path.rules.SpeedZoneEnablerQuery`		the speed zone enabler query
Errors	NULL_ARGUMENT		`speedZoneEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`speedZoneEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.