Interface TriggerEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
TriggerEnablerSearchSession
public interface TriggerEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated system view: searches include trigger enablers in systems of which this system is an ancestor in the system hierarchy
  • isolated system view: searches are restricted to trigger enablers in this system

Device constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the TriggerEnablerQuery.

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

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canSearchTriggerEnablers

      boolean canSearchTriggerEnablers()
      Tests if this user can perform TriggerEnabler 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.

    • useFederatedSystemView

      void useFederatedSystemView()
      Federates the view for methods in this session. A federated view will include trigger enablers in systems which are children of this broker in the system hierarchy.
      Compliance:
      mandatory - This method must be implemented.

    • useIsolatedSystemView

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

    • getTriggerEnablerQuery

      TriggerEnablerQuery getTriggerEnablerQuery()
      Gets a trigger enabler query.
      Returns:
      the trigger enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getTriggerEnablersByQuery

      TriggerEnablerList getTriggerEnablersByQuery(TriggerEnablerQuery triggerEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of TriggerEnablers matching the given search.
      Parameters:
      triggerEnablerQuery - the device constraienr enabler query
      Returns:
      the returned TriggerEnablerList
      Throws:
      NullArgumentException - triggerEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - triggerEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.