Interface BrokerEnablerDistributorSession

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

This session provides methods to retrieve BrokerEnabler to Distributor mappings. A BrokerEnabler may appear in multiple Distributor objec ts. Each distributor 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

    • canLookupBrokerEnablerDistributorMappings

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

    • useComparativeBrokerEnablerDistributorView

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

    • usePlenaryBrokerEnablerDistributorView

      void usePlenaryBrokerEnablerDistributorView()
      A complete view of the BrokerEnabler 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.

    • getBrokerEnablerIdsByDistributor

      IdList getBrokerEnablerIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of BrokerEnabler Ids associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related broker enabler 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.

    • getBrokerEnablersByDistributor

      BrokerEnablerList getBrokerEnablersByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of BrokerEnablers associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related broker enablers
      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.

    • getBrokerEnablerIdsByDistributors

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

    • getBrokerEnablersByDistributors

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

    • getDistributorIdsByBrokerEnabler

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

    • getDistributorsByBrokerEnabler

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