Interface QueueConstrainerRuleLookupSession

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

This session provides methods to retrieve QueueConstrainer to Queue mappings. A Queue with multiple QueueConstrainers means any positive rule evaluation across the constrainers result in an accessible Queue .

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

  • Method Details

    • getFrontOfficeId

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

    • getFrontOffice

      FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
      Gets the FrontOffice associated with this session.
      Returns:
      the office
      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.

    • useFederatedFrontOfficeView

      void useFederatedFrontOfficeView()
      Federates the view for methods in this session. A federated view will include queue constrainer in front offices which are children of this front office in the front office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFrontOfficeView

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

    • getQueueConstrainerIdsForQueue

      IdList getQueueConstrainerIdsForQueue(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueConstrainer Id 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 QueueConstrainer 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.