Interface QueueProcessorEnablerRuleLookupSession

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

This session provides methods to retrieve QueueProcessorEnabler to QueueProcessor mappings. a QueueProcessor with multiple QueueProcessorEnablers means any positive rule evaluation across the enablers result in an effective QueueProcessor .

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

    • canLookupQueueProcessorEnablerRules

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

    • useComparativeQueueProcessorEnablerRuleView

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

    • usePlenaryQueueProcessorEnablerRuleView

      void usePlenaryQueueProcessorEnablerRuleView()
      A complete view of the QueueProcessorEnabler and QueueProcessor 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 processor 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.

    • getQueueProcessorEnablerIdsForQueueProcessor

      IdList getQueueProcessorEnablerIdsForQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueProcessorEnabler Id associated with a QueueProcessor .
      Parameters:
      queueProcessorId - Id of the QueueProcessor
      Returns:
      the queue processor enabler 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.

    • getQueueProcessorEnablersForQueueProcessor

      QueueProcessorEnablerList getQueueProcessorEnablersForQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueProcessorEnabler associated with a QueueProcessor .
      Parameters:
      queueProcessorId - Id of the QueueProcessor
      Returns:
      the queue processor enablers
      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.

    • getQueueProcessorIdsForQueueProcessorEnabler

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

    • getQueueProcessorsForQueueProcessorEnabler

      QueueProcessorList getQueueProcessorsForQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueProcessors mapped to a QueueProcessorEnabler .
      Parameters:
      queueProcessorEnablerId - Id of a QueueProcessorEnabler
      Returns:
      list of queue processors
      Throws:
      NotFoundException - queueProcessorEnablerId is not found
      NullArgumentException - queueProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.