Interface BrokerEnablerSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A BrokerEnablerQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of BrokerEnablers . The broker enablers may be sequenced using the BrokerEnablerSearchOrder from this session.

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

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

    • getBrokerEnablerQuery

      BrokerEnablerQuery getBrokerEnablerQuery()
      Gets a broker enabler query.
      Returns:
      the broker enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerEnablerSearchOrder

      BrokerEnablerSearchOrder getBrokerEnablerSearchOrder()
      Gets a broker enabler search order.
      Returns:
      the broker enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyBrokerEnablerQuery

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

    • inspectBrokerEnablerQuery

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

    • applyBrokerEnablerSequencing

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

    • getBrokerEnablerQueryFromInspector

      BrokerQuery getBrokerEnablerQueryFromInspector(BrokerEnablerQueryInspector brokerEnablerQueryInspector)
      Gets a broker enabler query from an inspector.
      Parameters:
      brokerEnablerQueryInspector - a broker enabler query inspector
      Returns:
      the broker enabler query
      Throws:
      NullArgumentException - brokerEnablerQueryInspector is null
      UnsupportedException - brokerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.