Interface BrokerProcessorEnablerDistributorSession

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

This session provides methods to retrieve BrokerprocessorEnabler to Distributor mappings. A BrokerProcessorEnabler 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

    • canLookupBrokerProcessorEnablerDistributorMappings

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

    • useComparativeBrokerProcessorEnablerDistributorView

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

    • usePlenaryBrokerProcessorEnablerDistributorView

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

    • getBrokerProcessorEnablerIdsByDistributor

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

    • getBrokerProcessorEnablersByDistributor

      BrokerProcessorEnablerList getBrokerProcessorEnablersByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of BrokerProcessorEnablers associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related broker processor 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.

    • getBrokerProcessorEnablerIdsByDistributors

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

    • getBrokerProcessorEnablersByDistributors

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

    • getDistributorIdsByBrokerProcessorEnabler

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

    • getDistributorsByBrokerProcessorEnabler

      DistributorList getDistributorsByBrokerProcessorEnabler(Id brokerProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Distributors mapped to a BrokerProcessorEnabler .
      Parameters:
      brokerProcessorEnablerId - Id of a BrokerProcessorEnabler
      Returns:
      list of distributors
      Throws:
      NotFoundException - brokerProcessorEnablerId is not found
      NullArgumentException - brokerProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.