Interface BrokerProcessorEnablerSmartDistributorSession

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

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

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

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

    • getBrokerProcessorEnablerQuery

      BrokerProcessorEnablerQuery getBrokerProcessorEnablerQuery()
      Gets a broker processor enabler query.
      Returns:
      the broker processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorEnablerSearchOrder

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

    • applyBrokerProcessorEnablerQuery

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

    • inspectBrokerProcessorEnablerQuery

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

    • applyBrokerProcessorEnablerSequencing

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

    • getBrokerProcessorEnablerQueryFromInspector

      BrokerProcessorEnablerQuery getBrokerProcessorEnablerQueryFromInspector(BrokerProcessorEnablerQueryInspector brokerProcessorEnablerQueryInspector)
      Gets a broker processor enabler query from an inspector.
      Parameters:
      brokerProcessorEnablerQueryInspector - a broker processor enabler query inspector
      Returns:
      the broker processor enabler query
      Throws:
      NullArgumentException - brokerProcessorEnablerQueryInspector is null
      UnsupportedException - brokerProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.