Interface QueueConstrainerSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A QueueConstrainerQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of QueueConstrainers . The queue constrainers may be sequenced using the QueueConstrainerSearchOrder from this session.

This Distributor has a default query that matches any queue constrainer and a default search order that specifies no sequencing. The queries may be examined using a QueueConstrainerQueryInspector . The query may be modified by converting the inspector back to a QueueConstrainerQuery .

  • Method Details

    • getDistributorId

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

    • getDistributor

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

    • canManageSmartDistributors

      boolean canManageSmartDistributors()
      Tests if this user can manage smart distributors. 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 distributor management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerQuery

      QueueConstrainerQuery getQueueConstrainerQuery()
      Gets a queue constrainer query.
      Returns:
      the queue constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerSearchOrder

      QueueConstrainerSearchOrder getQueueConstrainerSearchOrder()
      Gets a queue constrainer search order.
      Returns:
      the queue constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyQueueConstrainerQuery

      void applyQueueConstrainerQuery(QueueConstrainerQuery queueConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a queue constrainer query to this distributor.
      Parameters:
      queueConstrainerQuery - the queue constrainer query
      Throws:
      NullArgumentException - queueConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - queueConstrainerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectQueueConstrainerQuery

      QueueConstrainerQueryInspector inspectQueueConstrainerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a queue constrainer query inspector for this distributor.
      Returns:
      the queue constrainer query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyQueueConstrainerSequencing

      void applyQueueConstrainerSequencing(QueueConstrainerSearchOrder queueConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a queue constrainer search order to this distributor.
      Parameters:
      queueConstrainerSearchOrder - the queue constrainer search order
      Throws:
      NullArgumentException - queueConstrainerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - queueConstrainerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerQueryFromInspector

      QueueConstrainerQuery getQueueConstrainerQueryFromInspector(QueueConstrainerQueryInspector queueConstrainerQueryInspector)
      Gets a queue constrainer query from an inspector.
      Parameters:
      queueConstrainerQueryInspector - a queue constrainer query inspector
      Returns:
      the queue constrainer query
      Throws:
      NullArgumentException - queueConstrainerQueryInspector is null
      UnsupportedException - queueConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.