Interface SignalEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
SignalEnablerSearchSession
public interface SignalEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

signal enabler may have a query record indicated by their respective record types. The query record is accessed via the SignalEnablerQuery.

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

    • canSearchSignalEnablers

      boolean canSearchSignalEnablers()
      Tests if this user can perform SignalEnabler 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 signal enabler in maps which are children of this broker 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.

    • getSignalEnablerQuery

      SignalEnablerQuery getSignalEnablerQuery()
      Gets a signal enabler query.
      Returns:
      the signal enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getSignalEnablersByQuery

      SignalEnablerList getSignalEnablersByQuery(SignalEnablerQuery signalEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of SignalEnablers matching the given signal enabler query.
      Parameters:
      signalEnablerQuery - the signal enabler query
      Returns:
      the returned SignalEnablerList
      Throws:
      NullArgumentException - signalEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - signalEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.