Interface SignalQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
SignalSearchSession
public interface SignalQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchSignals

      boolean canSearchSignals()
      Tests if this user can perform Signal 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 signals in maps which are children of this map in the map hierarchy.
      Compliance:
      mandatory - This method is 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 is must be implemented.

    • getSignalQuery

      SignalQuery getSignalQuery()
      Gets a signal query.
      Returns:
      the signal query
      Compliance:
      mandatory - This method must be implemented.

    • getSignalsByQuery

      SignalList getSignalsByQuery(SignalQuery signalQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Signals matching the given signal query.
      Parameters:
      signalQuery - the signal query
      Returns:
      the returned SignalList
      Throws:
      NullArgumentException - signalQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - signalQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.