Interface BrokerConstrainerEnablerDistributorSession

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

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

    • canLookupBrokerConstrainerEnablerDistributorMappings

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

    • useComparativeBrokerConstrainerEnablerDistributorView

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

    • usePlenaryBrokerConstrainerEnablerDistributorView

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

    • getBrokerConstrainerEnablerIdsByDistributor

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

    • getBrokerConstrainerEnablersByDistributor

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

    • getBrokerConstrainerEnablerIdsByDistributors

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

    • getBrokerConstrainerEnablersByDistributors

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

    • getDistributorIdsByBrokerConstrainerEnabler

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

    • getDistributorsByBrokerConstrainerEnabler

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