Interface BrokerProcessorDistributorSession

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

This session provides methods to retrieve BrokerProcessor to Distributor mappings. A BrokerProcessor may appear in multiple Distributors. Each d istributor may have its own authorizations governing who is allowed to look at it.

This 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

  • Method Details

    • canLookupBrokerProcessorDistributorMappings

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

    • useComparativeBrokerProcessorDistributorView

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

    • usePlenaryBrokerProcessorDistributorView

      void usePlenaryBrokerProcessorDistributorView()
      A complete view of the BrokerProcessor and Distributor 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.

    • getBrokerProcessorIdsByDistributor

      IdList getBrokerProcessorIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of BrokerProcessorIds associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related broker processor Ids
      Throws:
      NotFoundException - distributorId is not found
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorsByDistributor

      BrokerProcessorList getBrokerProcessorsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of BrokerProcessors associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related broker processors
      Throws:
      NotFoundException - distributorId is not found
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorIdsByDistributors

      IdList getBrokerProcessorIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of BrokerConstrainerIds corresponding to a list of Distributors .
      Parameters:
      distributorIds - list of distributor Ids
      Returns:
      list of broker processor Ids
      Throws:
      NullArgumentException - distributorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorsByDistributors

      BrokerProcessorList getBrokerProcessorsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of BrokerConstrainers corresponding to a list of Distributors .
      Parameters:
      distributorIds - list of distributor Ids
      Returns:
      list of broker processors
      Throws:
      NullArgumentException - distributorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDistributorIdsByBrokerProcessor

      IdList getDistributorIdsByBrokerProcessor(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Distributor Ids mapped to a BrokerProcessor .
      Parameters:
      brokerProcessorId - Id of a BrokerProcessor
      Returns:
      list of distributor 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.

    • getDistributorsByBrokerProcessor

      DistributorList getDistributorsByBrokerProcessor(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Distributors mapped to a BrokerConstrainer .
      Parameters:
      brokerProcessorId - Id of a BrokerProcessor
      Returns:
      list of distributors
      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.