Interface IntersectionSmartMapSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface IntersectionSmartMapSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An IntersectionQuery can be retrieved from this session and mapped to this Map to create a virtual collection of Intersections . The intersections may be sequenced using the IntersectionSearchOrder from this session.

This Map has a default query that matches any intersection and a default search order that specifies no sequencing. The queries may be examined using an IntersectionQueryInspector . The query may be modified by converting the inspector back to an IntersectionQuery .

  • 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.

    • canManageSmartMaps

      boolean canManageSmartMaps()
      Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart map management is not authorized, true otherwise
      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.

    • getIntersectionSearchOrder

      IntersectionSearchOrder getIntersectionSearchOrder()
      Gets an intersection search order.
      Returns:
      the intersection search order
      Compliance:
      mandatory - This method must be implemented.

    • applyIntersectionQuery

      void applyIntersectionQuery(IntersectionQuery intersectionQuery) throws OperationFailedException, PermissionDeniedException
      Applies an intersection query to this map.
      Parameters:
      intersectionQuery - the intersection query
      Throws:
      NullArgumentException - intersectionQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - intersectionQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectIntersectionQuery

      IntersectionQueryInspector inspectIntersectionQuery() throws OperationFailedException, PermissionDeniedException
      Gets an intersection query inspector for this map.
      Returns:
      the intersection query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyIntersectionSequencing

      void applyIntersectionSequencing(IntersectionSearchOrder intersectionSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an intersection search order to this map.
      Parameters:
      intersectionSearchOrder - the intersection search order
      Throws:
      NullArgumentException - intersectionSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - intersectionsearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getIntersectionQueryFromInspector

      IntersectionQuery getIntersectionQueryFromInspector(IntersectionQueryInspector intersectionQueryInspector)
      Gets an intersection query from an inspector.
      Parameters:
      intersectionQueryInspector - an intersection query inspector
      Returns:
      the intersection query
      Throws:
      NullArgumentException - intersectionQueryInspector is null
      UnsupportedException - intersectionQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.