Interface BrokerEnablerRuleLookupSession

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

This session provides methods to retrieve BrokerEnabler to Broker mappings.

Th is lookup session defines several views:
  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated distributor view: All methods in this session operate, retrieve and pertain to broker enablers defined explicitly in the current distributor
  • federated distributor view: All methods in this session operate, retrieve and pertain to all broker enablers defined in this distributor and any other broker enablers implicitly available in this distributor through distributor inheritence.

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

    • canLookupBrokerEnablerRules

      boolean canLookupBrokerEnablerRules()
      Tests if this user can perform lookups of broker enabler/broker mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeBrokerEnablerRuleView

      void useComparativeBrokerEnablerRuleView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryBrokerEnablerRuleView

      void usePlenaryBrokerEnablerRuleView()
      A complete view of the BrokerEnabler and Broker returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedDistributorView

      void useFederatedDistributorView()
      Federates the view for methods in this session. A federated view will include broker enablers in distributors which are children of this distributor in the distributor hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDistributorView

      void useIsolatedDistributorView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.
      Compliance:
      mandatory - This method is must be implemented.

    • getBrokerEnablerIdsForBroker

      IdList getBrokerEnablerIdsForBroker(Id brokerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BrokerEnabler Ids associated with a Broker .
      Parameters:
      brokerId - Id of the Broker
      Returns:
      the broker enabler Ids
      Throws:
      NotFoundException - brokerId is not found
      NullArgumentException - brokerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerEnablersForBroker

      BrokerEnablerList getBrokerEnablersForBroker(Id brokerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BrokerEnablers associated with a Broker .
      Parameters:
      brokerId - Id of the Broker
      Returns:
      the broker enablers
      Throws:
      NotFoundException - brokerId is not found
      NullArgumentException - brokerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerIdsForBrokerEnabler

      IdList getBrokerIdsForBrokerEnabler(Id brokerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Broker Ids mapped to a BrokerEnabler .
      Parameters:
      brokerEnablerId - Id of a BrokerEnabler
      Returns:
      list of broker Ids
      Throws:
      NotFoundException - brokerEnablerId is not found
      NullArgumentException - brokerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokersForBrokerEnabler

      BrokerList getBrokersForBrokerEnabler(Id brokerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Brokers mapped to a BrokerEnabler .
      Parameters:
      brokerEnablerId - Id of a BrokerEnabler
      Returns:
      list of brokers
      Throws:
      NotFoundException - brokerEnablerId is not found
      NullArgumentException - brokerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.