Interface QueueEnablerDistributorSession

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

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

    • canLookupQueueEnablerDistributorMappings

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

    • useComparativeQueueEnablerDistributorView

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

    • usePlenaryQueueEnablerDistributorView

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

    • getQueueEnablerIdsByDistributor

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

    • getQueueEnablersByDistributor

      QueueEnablerList getQueueEnablersByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of QueueEnablers associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related queue 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.

    • getQueueEnablerIdsByDistributors

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

    • getQueueEnablersByDistributors

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

    • getDistributorIdsByQueueEnabler

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

    • getDistributorsByQueueEnabler

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