Interface ProvisionSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProvisionQuery can be retrieved from this session and distributorped to this Distributor to create a virtual collection of Provisions . The provisions may be sequenced using the ProvisionSearchOrder from this session.

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

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

    • getProvisionQuery

      ProvisionQuery getProvisionQuery()
      Gets a provision query.
      Returns:
      the provision query
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionSearchOrder

      ProvisionSearchOrder getProvisionSearchOrder()
      Gets a provision search order.
      Returns:
      the provision search order
      Compliance:
      mandatory - This method must be implemented.

    • applyProvisionQuery

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

    • inspectProvisionQuery

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

    • applyProvisionSequencing

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

    • getProvisionQueryFromInspector

      ProvisionQuery getProvisionQueryFromInspector(ProvisionQueryInspector provisionQueryInspector)
      Gets a provision query from an inspector.
      Parameters:
      provisionQueryInspector - a provision query inspector
      Returns:
      the provision query
      Throws:
      NullArgumentException - provisionQueryInspector is null
      UnsupportedException - provisionQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.