Interface IntersectionQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
IntersectionSearchSession
public interface IntersectionQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

Intersections may have a query record indicated by their respective record types. The query record is accessed via the IntersectionQuery.

Like all OsidSessions, IntersectionQuerySessions 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.

    • canSearchIntersections

      boolean canSearchIntersections()
      Tests if this user can perform Intersection 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 intersections in maps which are children of this map 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 searches to this map only.
      Compliance:
      mandatory - This method must be implemented.

    • getIntersectionQuery

      IntersectionQuery getIntersectionQuery()
      Gets an intersection query.
      Returns:
      the intersection query
      Compliance:
      mandatory - This method must be implemented.

    • getIntersectionsByQuery

      IntersectionList getIntersectionsByQuery(IntersectionQuery intersectionQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Intersections matching the given inttersection query.
      Parameters:
      intersectionQuery - the intersection query
      Returns:
      the returned IntersectionList
      Throws:
      NullArgumentException - intersectionQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - intersectionQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.