Interface QueueConstrainerEnablerSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A QueueConstrainerEnablerQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of QueueConstrainerEnablers . The queue constrainer enablers may be sequenced using the QueueConstrainerEnablerSearchOrder from this session.

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

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

    • getQueueConstrainerEnablerQuery

      QueueConstrainerEnablerQuery getQueueConstrainerEnablerQuery()
      Gets a queue constrainer enabler query.
      Returns:
      the queue constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerEnablerSearchOrder

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

    • applyQueueConstrainerEnablerQuery

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

    • inspectQueueConstrainerEnablerQuery

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

    • applyQueueConstrainerEnablerSequencing

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

    • getQueueConstrainerEnablerQueryFromInspector

      QueueConstrainerEnablerQuery getQueueConstrainerEnablerQueryFromInspector(QueueConstrainerEnablerQueryInspector queueConstrainerEnablerQueryInspector)
      Gets a queue constrainer enabler query from an inspector.
      Parameters:
      queueConstrainerEnablerQueryInspector - a queue constrainer enabler query inspector
      Returns:
      the queue constrainer enabler query
      Throws:
      NullArgumentException - queueConstrainerEnablerQueryInspector is null
      UnsupportedException - queueConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.