Interface TriggerEnablerSmartSystemSession

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

This session manages queries and sequencing to create "smart" dynamic systems. A TriggerEnablerQuery can be retrieved from this session and mapped to this System to create a virtual collection of trigger enablers. The trigger enablers may be sequenced using the TriggerEnablerSearchOrder from this session.

This System has a default query that matches any trigger enabler and a default search order that specifies no sequencing. The queries may be examined using a TriggerEnablerQueryInspector. The query may be modified by converting the inspector back to a TriggerEnablerQuery.

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

    • canManageSmartSystems

      boolean canManageSmartSystems()
      Tests if this user can manage smart systems. 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 system management is not authorized, true otherwise
      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.

    • getTriggerEnablerSearchOrder

      TriggerEnablerSearchOrder getTriggerEnablerSearchOrder()
      Gets a trigger enabler search order.
      Returns:
      the trigger enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyTriggerEnablerQuery

      void applyTriggerEnablerQuery(TriggerEnablerQuery triggerEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a trigger enabler query to this system.
      Parameters:
      triggerEnablerQuery - the trigger enabler query
      Throws:
      NullArgumentException - triggerEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - triggerEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectTriggerEnablerQuery

      TriggerEnablerQueryInspector inspectTriggerEnablerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a trigger enabler query inspector for this system.
      Returns:
      the trigger enabler query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyTriggerEnablerSequencing

      void applyTriggerEnablerSequencing(TriggerEnablerSearchOrder triggerEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a trigger enabler search order to this system.
      Parameters:
      triggerEnablerSearchOrder - the trigger enabler search order
      Throws:
      NullArgumentException - triggerEnablerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - triggerEnablerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getTriggerEnablerQueryFromInspector

      TriggerEnablerQuery getTriggerEnablerQueryFromInspector(TriggerEnablerQueryInspector triggerEnablerQueryInspector)
      Gets a trigger enabler query from an inspector.
      Parameters:
      triggerEnablerQueryInspector - a trigger enabler query inspector
      Returns:
      the trigger enabler query
      Throws:
      NullArgumentException - triggerEnablerQueryInspector is null
      UnsupportedException - triggerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.