Interface ProvisionEnablerSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProvisionEnablerQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of ProvisionEnablers . The provision enablers may be sequenced using the ProvisionEnablerSearchOrder from this session.

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

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

    • getProvisionEnablerQuery

      ProvisionEnablerQuery getProvisionEnablerQuery()
      Gets a provision enabler query.
      Returns:
      the provision enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionEnablerSearchOrder

      ProvisionEnablerSearchOrder getProvisionEnablerSearchOrder()
      Gets a provision enabler search order.
      Returns:
      the provision enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyProvisionEnablerQuery

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

    • inspectProvisionEnablerQuery

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

    • applyProvisionEnablerSequencing

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

    • getProvisionEnablerQueryFromInspector

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