Interface BrokerProcessorRuleLookupSession

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

This session provides methods to retrieve BrokerProcessor 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 processoras defined explicitly in the current distributor
  • federated distributor view: All methods in this session operate, retrieve and pertain to all broker processors defined in this distributor and any other broker processors 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.

    • canLookupBrokerProcessorRules

      boolean canLookupBrokerProcessorRules()
      Tests if this user can perform lookups of broker processor/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.

    • useComparativeBrokerProcessorRuleView

      void useComparativeBrokerProcessorRuleView()
      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.

    • usePlenaryBrokerProcessorRuleView

      void usePlenaryBrokerProcessorRuleView()
      A complete view of the BrokerProcessor 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 processors 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.

    • getBrokerProcessorIdsForBroker

      IdList getBrokerProcessorIdsForBroker(Id brokerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BrokerProcessor Ids associated with a Broker .
      Parameters:
      brokerId - Id of the Broker
      Returns:
      the broker processor 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.

    • getBrokerProcessorsForBroker

      BrokerProcessorList getBrokerProcessorsForBroker(Id brokerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BrokerProcessors associated with a Broker .
      Parameters:
      brokerId - Id of the Broker
      Returns:
      the broker processors
      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.

    • getBrokerIdsForBrokerProcessor

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

    • getBrokersForBrokerProcessor

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