Interface BrokerConstrainerDistributorSession

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

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

    • canLookupBrokerConstrainerDistributorMappings

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

    • useComparativeBrokerConstrainerDistributorView

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

    • usePlenaryBrokerConstrainerDistributorView

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

    • getBrokerConstrainerIdsByDistributor

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

    • getBrokerConstrainersByDistributor

      BrokerConstrainerList getBrokerConstrainersByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of BrokerConstrainers associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related broker constrainers
      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.

    • getBrokerConstrainerIdsByDistributors

      IdList getBrokerConstrainerIdsByDistributors(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 constrainer Ids
      Throws:
      NullArgumentException - distributorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerConstrainersByDistributors

      BrokerConstrainerList getBrokerConstrainersByDistributors(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 constrainers
      Throws:
      NullArgumentException - distributorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDistributorIdsByBrokerConstrainer

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

    • getDistributorsByBrokerConstrainer

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