Interface QueueConstrainerRuleLookupSession

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

This session provides methods to retrieve QueueConstrainer to Queue mappings.

Th is 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
  • isolated distributor view: All methods in this session operate, retrieve and pertain to queue constrainers defined explicitly in the current distributor
  • federated distributor view: All methods in this session operate, retrieve and pertain to all queue constrainers defined in this distributor and any other queue constrainers implicitly available in this distributor through distributor inheritence.

  • Method Details

    • getDistributorId

      Id getDistributorId()
      Gets the Distributor Id associated with this session.
      Returns:
      the Distributor Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getDistributor

      Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
      Gets the Distributor associated with this session.
      Returns:
      the distributor
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupQueueConstrainerRules

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

    • useComparativeQueueConstrainerRuleView

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

    • usePlenaryQueueConstrainerRuleView

      void usePlenaryQueueConstrainerRuleView()
      A complete view of the QueueConstrainer and Queue 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.

    • useFederatedDistributorView

      void useFederatedDistributorView()
      Federates the view for methods in this session. A federated view will include queue constrainers in distributors which are children of this distributor in the distributor hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDistributorView

      void useIsolatedDistributorView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.
      Compliance:
      mandatory - This method is must be implemented.

    • getQueueConstrainerIdsForQueue

      IdList getQueueConstrainerIdsForQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueConstrainer Ids associated with a Queue .
      Parameters:
      queueId - Id of the Queue
      Returns:
      the queue constrainer Ids
      Throws:
      NotFoundException - queueId is not found
      NullArgumentException - queueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainersForQueue

      QueueConstrainerList getQueueConstrainersForQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueConstrainers associated with a Queue .
      Parameters:
      queueId - Id of the Queue
      Returns:
      the queue constrainers
      Throws:
      NotFoundException - queueId is not found
      NullArgumentException - queueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueIdsForQueueConstrainer

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

    • getQueuesForQueueConstrainer

      QueueList getQueuesForQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Queues mapped to a QueueConstrainer .
      Parameters:
      queueConstrainerId - Id of a QueueConstrainer
      Returns:
      list of queues
      Throws:
      NotFoundException - queueConstrainerId is not found
      NullArgumentException - queueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.