Interface BrokerProcessorSmartDistributorSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A BrokerProcessorQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of BrokerProcessors . The broker processors may be sequenced using the BrokerProcessorSearchOrder from this session.

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

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

    • getBrokerProcessorQuery

      BrokerProcessorQuery getBrokerProcessorQuery()
      Gets a broker processor query.
      Returns:
      the broker processor query
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorSearchOrder

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

    • applyBrokerProcessorQuery

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

    • inspectBrokerProcessorQuery

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

    • applyBrokerProcessorSequencing

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

    • getBrokerProcessorQueryFromInspector

      BrokerProcessorQuery getBrokerProcessorQueryFromInspector(BrokerProcessorQueryInspector brokerProcessorQueryInspector)
      Gets a broker processor query from an inspector.
      Parameters:
      brokerProcessorQueryInspector - a broker processor query inspector
      Returns:
      the broker processor query
      Throws:
      NullArgumentException - brokerProcessorQueryInspector is null
      UnsupportedException - brokerProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.