Interface ProvisionableEnablerSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProvisionableEnablerQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of ProvisionableEnablers . The provisionable enablers may be sequenced using the ProvisionableEnablerSearchOrder from this session.

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

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

    • getProvisionableEnablerQuery

      ProvisionableEnablerQuery getProvisionableEnablerQuery()
      Gets a provisionable enabler query.
      Returns:
      the provisionable enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionableEnablerSearchOrder

      ProvisionableEnablerSearchOrder getProvisionableEnablerSearchOrder()
      Gets a provisionable enabler search order.
      Returns:
      the provisionable enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyProvisionableEnablerQuery

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

    • inspectProvisionableEnablerQuery

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

    • applyProvisionableEnablerSequencing

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

    • getProvisionableEnablerQueryFromInspector

      ProvisionableQuery getProvisionableEnablerQueryFromInspector(ProvisionableEnablerQueryInspector provisionableEnablerQueryInspector)
      Gets a provisionable enabler query from an inspector.
      Parameters:
      provisionableEnablerQueryInspector - a provisionable enabler query inspector
      Returns:
      the provisionable enabler query
      Throws:
      NullArgumentException - provisionableEnablerQueryInspector is null
      UnsupportedException - provisionableEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.