Interface SpeedZoneEnablerQuerySession

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

This session provides methods for searching among SpeedZoneEnabler objects. The search query is constructed using the SpeedZoneEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated map view: searches include speed zone enablers in map of which this map is an ancestor in the map hierarchy
  • isolated map view: searches are restricted to speed zone enablers in this map

Speed zone enablers may have a query record indicated by their respective record types. The query record is accessed via the SpeedZoneEnablerQuery.

Like all OsidSessions, SpeedZoneEnablerQuerySessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getMapId

      Id getMapId()
      Gets the Map Id associated with this session.
      Returns:
      the Map Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getMap

      Map getMap() throws OperationFailedException, PermissionDeniedException
      Gets the Map associated with this session.
      Returns:
      the map
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchSpeedZoneEnablers

      boolean canSearchSpeedZoneEnablers()
      Tests if this user can perform SpeedZoneEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedMapView

      void useFederatedMapView()
      Federates the view for methods in this session. A federated view will include speed zone enablers in maps which are children of this speed zone in the map hierarchy.
      Compliance:
      mandatory - This method must be implemented.

    • useIsolatedMapView

      void useIsolatedMapView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this map only.
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedZoneEnablerQuery

      SpeedZoneEnablerQuery getSpeedZoneEnablerQuery()
      Gets a speed zone enabler query.
      Returns:
      the speed zone enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedZoneEnablersByQuery

      SpeedZoneEnablerList getSpeedZoneEnablersByQuery(SpeedZoneEnablerQuery speedZoneEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of SpeedZoneEnablers matching the given speed zone enabler query.
      Parameters:
      speedZoneEnablerQuery - the sespeed zone enabler query
      Returns:
      the returned SpeedZoneEnablerList
      Throws:
      NullArgumentException - speedZoneEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - speedZoneEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.