Interface PoolEnablerSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A PoolEnablerQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of PoolEnablers . The pool enablers may be sequenced using the PoolEnablerSearchOrder from this session.

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

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

    • getPoolEnablerQuery

      PoolEnablerQuery getPoolEnablerQuery()
      Gets a pool enabler query.
      Returns:
      the pool enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getPoolEnablerSearchOrder

      PoolEnablerSearchOrder getPoolEnablerSearchOrder()
      Gets a pool enabler search order.
      Returns:
      the pool enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyPoolEnablerQuery

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

    • inspectPoolEnablerQuery

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

    • applyPoolEnablerSequencing

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

    • getPoolEnablerQueryFromInspector

      PoolQuery getPoolEnablerQueryFromInspector(PoolEnablerQueryInspector poolEnablerQueryInspector)
      Gets a pool enabler query from an inspector.
      Parameters:
      poolEnablerQueryInspector - a pool enabler query inspector
      Returns:
      the pool enabler query
      Throws:
      NullArgumentException - poolEnablerQueryInspector is null
      UnsupportedException - poolEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.