Interface QueueConstrainerEnablerRuleLookupSession

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

This session provides methods to retrieve QueueConstrainerEnabler to QueueConstrainer mappings. a Queue with multiple QueueConstrainerEnablers means any positive rule evaluation across the enablers result in an effective QueueConstrainer .

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

    • canLookupQueueConstrainerEnablerRules

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

    • useComparativeQueueConstrainerEnablerRuleView

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

    • usePlenaryQueueConstrainerEnablerRuleView

      void usePlenaryQueueConstrainerEnablerRuleView()
      A complete view of the QueueConstrainerEnabler and QueueConstrainer 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 enablers 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.

    • getQueueConstrainerEnablerIdsForQueueConstrainer

      IdList getQueueConstrainerEnablerIdsForQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueConstrainerEnablerId associated with a QueueConstrainer .
      Parameters:
      queueConstrainerId - Id of the QueueConstrainer
      Returns:
      the queue constrainer enabler 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.

    • getQueueConstrainerEnablersForQueueConstrainer

      QueueConstrainerEnablerList getQueueConstrainerEnablersForQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueConstrainerEnablers associated with a QueueConstrainer .
      Parameters:
      queueConstrainerId - Id of the QueueConstrainer
      Returns:
      the queue constrainer enablers
      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.

    • getQueueConstrainerIdsForQueueConstrainerEnabler

      IdList getQueueConstrainerIdsForQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueConstrainer Ids mapped to a QueueConstrainerEnabler .
      Parameters:
      queueConstrainerEnablerId - Id of a QueueConstrainerEnabler
      Returns:
      list of queue constrainer 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.

    • getQueueConstrainersForQueueConstrainerEnabler

      QueueConstrainerList getQueueConstrainersForQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueConstrainers mapped to a QueueConstrainerEnabler .
      Parameters:
      queueConstrainerEnablerId - Id of a QueueConstrainerEnabler
      Returns:
      list of queue constrainers
      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.