Interface ActionGroupSmartSystemSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An ActionGroupQuery can be retrieved from this session and mapped to this System to create a virtual collection of ActionGroups . The action groups may be sequenced using the ActionGroupSearchOrder from this session.

This System has a default query that matches any action group and a default search order that specifies no sequencing. The queries may be examined using an ActionGroupQueryInspector . The query may be modified by converting the inspector back to an ActionGroupQuery .

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

    • getActionGroupQuery

      ActionGroupQuery getActionGroupQuery()
      Gets an action group query.
      Returns:
      the action group query
      Compliance:
      mandatory - This method must be implemented.

    • getActionGroupSearchOrder

      ActionGroupSearchOrder getActionGroupSearchOrder()
      Gets an action group search order.
      Returns:
      the action group search order
      Compliance:
      mandatory - This method must be implemented.

    • applyActionGroupQuery

      void applyActionGroupQuery(ActionGroupQuery actuionGroupQuery) throws OperationFailedException, PermissionDeniedException
      Applies an action group query to this system.
      Parameters:
      actuionGroupQuery - the action group query
      Throws:
      NullArgumentException - actuionGroupQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - actuionGroupQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectActionGroupQuery

      ActionGroupQueryInspector inspectActionGroupQuery() throws OperationFailedException, PermissionDeniedException
      Gets an action group query inspector for this system.
      Returns:
      the action group query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyActionGroupSequencing

      void applyActionGroupSequencing(ActionGroupSearchOrder actionGroupSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an action group search order to this system.
      Parameters:
      actionGroupSearchOrder - the action group search order
      Throws:
      NullArgumentException - actionGroupSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - actionGroupSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getActionGroupQueryFromInspector

      ActionGroupQuery getActionGroupQueryFromInspector(ActionGroupQueryInspector actuionGroupQueryInspector)
      Gets an action group query from an inspector.
      Parameters:
      actuionGroupQueryInspector - an action group query inspector
      Returns:
      the action group query
      Throws:
      NullArgumentException - actuionGroupQueryInspector is null
      UnsupportedException - actuionGroupQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.