Interface BrokerConstrainerEnablerSmartDistributorSession

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

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

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

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

    • getBrokerConstrainerEnablerQuery

      BrokerConstrainerEnablerQuery getBrokerConstrainerEnablerQuery()
      Gets a broker constrainer enabler query.
      Returns:
      the broker constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerConstrainerEnablerSearchOrder

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

    • applyBrokerConstrainerEnablerQuery

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

    • inspectBrokerConstrainerEnablerQuery

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

    • applyBrokerConstrainerEnablerSequencing

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

    • getBrokerConstrainerEnablerQueryFromInspector

      BrokerConstrainerEnablerQuery getBrokerConstrainerEnablerQueryFromInspector(BrokerConstrainerEnablerQueryInspector brokerConstrainerEnablerQueryInspector)
      Gets a broker constrainer enabler query from an inspector.
      Parameters:
      brokerConstrainerEnablerQueryInspector - a broker constrainer enabler query inspector
      Returns:
      the broker constrainer enabler query
      Throws:
      NullArgumentException - brokerConstrainerEnablerQueryInspector is null
      UnsupportedException - brokerConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.