Interface QueueProcessorRuleLookupSession

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

This session provides methods to retrieve QueueProcessor 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 processoras defined explicitly in the current distributor
  • federated distributor view: All methods in this session operate, retrieve and pertain to all queue processors defined in this distributor and any other queue processors 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.

    • canLookupQueueProcessorRules

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

    • useComparativeQueueProcessorRuleView

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

    • usePlenaryQueueProcessorRuleView

      void usePlenaryQueueProcessorRuleView()
      A complete view of the QueueProcessor 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 processors 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.

    • getQueueProcessorIdsForQueue

      IdList getQueueProcessorIdsForQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueProcessor Ids associated with a Queue .
      Parameters:
      queueId - Id of the Queue
      Returns:
      the queue processor 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.

    • getQueueProcessorsForQueue

      QueueProcessorList getQueueProcessorsForQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueProcessors associated with a Queue .
      Parameters:
      queueId - Id of the Queue
      Returns:
      the queue processors
      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.

    • getQueueIdsForQueueProcessor

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

    • getQueuesForQueueProcessor

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