Interface QueueConstrainerEnablerDistributorSession

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

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

    • canLookupQueueConstrainerEnablerDistributorMappings

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

    • useComparativeQueueConstrainerEnablerDistributorView

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

    • usePlenaryQueueConstrainerEnablerDistributorView

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

    • getQueueConstrainerEnablerIdsByDistributor

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

    • getQueueConstrainerEnablersByDistributor

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

    • getQueueConstrainerEnablerIdsByDistributors

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

    • getQueueConstrainerEnablersByDistributors

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

    • getDistributorIdsByQueueConstrainerEnabler

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

    • getDistributorsByQueueConstrainerEnabler

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