Interface SpeedZoneEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SpeedZoneEnablerQuerySession
public interface SpeedZoneEnablerSearchSession extends SpeedZoneEnablerQuerySession

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 Details

    • getSpeedZoneEnablerSearch

      SpeedZoneEnablerSearch getSpeedZoneEnablerSearch()
      Gets a speed zone enabler search.
      Returns:
      the speed zone enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedZoneEnablerSearchOrder

      SpeedZoneEnablerSearchOrder getSpeedZoneEnablerSearchOrder()
      Gets a speed zone enabler search order. The SpeedZoneEnablerSearchOrder is supplied to a SpeedZoneEnablerSearch to specify the ordering of results.
      Returns:
      the speed zone enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedZoneEnablersBySearch

      SpeedZoneEnablerSearchResults getSpeedZoneEnablersBySearch(SpeedZoneEnablerQuery speedZoneEnablerQuery, SpeedZoneEnablerSearch speedZoneEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      speedZoneEnablerQuery - the speed zone enabler query
      speedZoneEnablerSearch - the speed zone enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - speedZoneEnablerQuery or speed zoneEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - speedZoneEnablerQuery or speed zoneEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedZoneEnablerQueryFromInspector

      SpeedZoneEnablerQuery getSpeedZoneEnablerQueryFromInspector(SpeedZoneEnablerQueryInspector speedZoneEnablerQueryInspector)
      Gets a speed zone enabler query from an inspector. The inspector is available from a SpeedZoneEnablerSearchResults.
      Parameters:
      speedZoneEnablerQueryInspector - a speed zone enabler query inspector
      Returns:
      the speed zone enabler query
      Throws:
      NullArgumentException - speedZoneEnablerQueryInspector is null
      UnsupportedException - speedZoneEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.