OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.SpeedZoneEnablerSearchSession
Implementsosid.mapping.path.rules.SpeedZoneEnablerQuerySession
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.

MethodgetSpeedZoneEnablerSearch
Description

Gets a speed zone enabler search.

Returnosid.mapping.path.rules.SpeedZoneEnablerSearchthe speed zone enabler search
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablerSearchOrder
Description

Gets a speed zone enabler search order. The SpeedZoneEnablerSearchOrder is supplied to a SpeedZoneEnablerSearch to specify the ordering of results.

Returnosid.mapping.path.rules.SpeedZoneEnablerSearchOrderthe speed zone enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.mapping.path.rules.SpeedZoneEnablerQueryspeedZoneEnablerQuerythe speed zone enabler query
osid.mapping.path.rules.SpeedZoneEnablerSearchspeedZoneEnablerSearchthe speed zone enabler search
Returnosid.mapping.path.rules.SpeedZoneEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT speedZoneEnablerQuery or speed zoneEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED speedZoneEnablerQuery or speed zoneEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablerQueryFromInspector
Description

Gets a speed zone enabler query from an inspector. The inspector is available from a SpeedZoneEnablerSearchResults.

Parametersosid.mapping.path.rules.SpeedZoneEnablerQueryInspectorspeedZoneEnablerQueryInspectora speed zone enabler query inspector
Returnosid.mapping.path.rules.SpeedZoneEnablerQuerythe speed zone enabler query
ErrorsNULL_ARGUMENT speedZoneEnablerQueryInspector is null
UNSUPPORTED speedZoneEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.