Interface TrackingRulesManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, TrackingRulesProfile
public interface TrackingRulesManager extends OsidManager, TrackingRulesProfile

The tracking rules manager provides access to tracking rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • QueueEnablerLookupSession : a session to retrieve queue enablers
  • QueueEnablerQuerySession : a session to query for queue enablers
  • QueueEnablerSearchSession : a session to search for queue enablers
  • QueueEnablerAdminSession : a session to create and delete queue enablers
  • QueueEnablerNotificationSession : a session to receive notifications pertaining to queue enabler changes
  • QueueEnablerFrontOfficeSession : a session to look up queue enabler front office mappings
  • QueueEnablerFrontOfficeAssignmentSession : a session to manage queue enabler to front office mappings
  • QueueEnablerSmartFrontOfficeSession : a session to manage dynamic front offices of queue enablers
  • QueueEnablerRuleLookupSession : a session to look up queue enablers to queue mappings
  • QueueEnablerRuleApplicationSession: a session to apply queue enablers to queues
  • QueueConstrainerLookupSession : a session to retrieve queue constrainer
  • QueueConstrainerQuerySession : a session to query for queue constrainer
  • QueueConstrainerSearchSession : a session to search for queue constrainer
  • QueueConstrainerAdminSession : a session to create and delete queue constrainer
  • QueueConstrainerNotificationSession : a session to receive notifications pertaining to queue constrainer changes
  • QueueConstrainerFrontOfficeSession : a session to look up queue constrainer front office mappings
  • QueueConstrainerFrontOfficeAssignmentSession : a session to manage queue constrainer to front office mappings
  • QueueConstrainerSmartFrontOfficeSession : a session to manage dynamic front office of queue constrainer
  • QueueConstrainerRuleLookupSession : a session to look up queue constrainer to queue mappings
  • QueueConstrainerRuleApplicationSession : a session to apply queue constrainer to queues
  • QueueConstrainerEnablerLookupSession : a session to retrieve queue constrainer enablers
  • QueueConstrainerEnablerQuerySession : a session to query for queue constrainer enablers
  • QueueConstrainerEnablerSearchSession : a session to search for queue constrainer enablers
  • QueueConstrainerEnablerAdminSession : a session to create and delete queue constrainer enablers
  • QueueConstrainerEnablerNotificationSession : a session to receive notifications pertaining to queue constrainer enabler changes
  • QueueConstrainerEnablerFrontOfficeSession : a session to look up queue constrainer enabler front office mappings
  • QueueConstrainerEnablerFrontOfficeAssignmentSession : a session to manage queue constrainer enabler to front office mappings
  • QueueConstrainerEnablerSmartFrontOfficeSession : a session to manage dynamic front office of queue constrainer enablers
  • QueueConstrainerEnableRuleLookupSession : a session to look up queue constrainer enabler mappings
  • QueueConstrainerEnablerRuleApplicationSession : a session to apply queue constrainer enablers
  • QueueProcessorLookupSession : a session to retrieve queue processor
  • QueueProcessorQuerySession : a session to query for queue processor
  • QueueProcessorSearchSession : a session to search for queue processor
  • QueueProcessorAdminSession : a session to create and delete queue processor
  • QueueProcessorNotificationSession : a session to receive notifications pertaining to queue processor changes
  • QueueProcessorFrontOfficeSession : a session to look up queue processor front office mappings
  • QueueProcessorFrontOfficeAssignmentSession : a session to manage queue processor to front office mappings
  • QueueProcessorSmartFrontOfficeSession : a session to manage dynamic front office of queue processor
  • QueueProcessorRuleLookupSession : a session to look up queue processor to queue mappings
  • QueueProcessorRuleApplicationSession : a session to apply queue processor to queues
  • QueueProcessorEnablerLookupSession : a session to retrieve queue processor enablers
  • QueueProcessorEnablerQuerySession : a session to query for queue processor enablers
  • QueueProcessorEnablerSearchSession : a session to search for queue processor enablers
  • QueueProcessorEnablerAdminSession : a session to create and delete queue processor enablers
  • QueueProcessorEnablerNotificationSession : a session to receive notifications pertaining to queue processor enabler changes
  • QueueProcessorEnablerFrontOfficeSession : a session to look up queue processor enabler front office mappings
  • QueueProcessorEnablerFrontOfficeAssignmentSession : a session to manage queue processor enabler to front office mappings
  • QueueProcessorEnablerSmartFrontOfficeSession : a session to manage dynamic front office of queue processor enablers
  • QueueProcessorEnablerRuleLookupSession : a session to look up queue processor enabler mappings
  • QueueProcessorEnablerRuleApplicationSession : a session to apply queue processor enablers

  • Method Details

    • getQueueEnablerLookupSession

      QueueEnablerLookupSession getQueueEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue enabler lookup service.
      Returns:
      a QueueEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerLookup()} is {@code true} .

    • getQueueEnablerLookupSessionForFrontOffice

      QueueEnablerLookupSession getQueueEnablerLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler lookup service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueEnablerLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueEnablerQuerySession

      QueueEnablerQuerySession getQueueEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the queue enabler query service.
      Returns:
      a QueueEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerQuery()} is {@code true} .

    • getQueueEnablerQuerySessionForFrontOffice

      QueueEnablerQuerySession getQueueEnablerQuerySessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler query service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueEnablerQuerySession
      Throws:
      NotFoundException - no front office found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueEnablerSearchSession

      QueueEnablerSearchSession getQueueEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the queue enabler search service.
      Returns:
      a QueueEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerSearch()} is {@code true} .

    • getQueueEnablerSearchSessionForFrontOffice

      QueueEnablerSearchSession getQueueEnablerSearchSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler search service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueEnablerSearchSession
      Throws:
      NotFoundException - no front office found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueEnablerAdminSession

      QueueEnablerAdminSession getQueueEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the queue enabler administration service.
      Returns:
      a QueueEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerAdmin()} is {@code true} .

    • getQueueEnablerAdminSessionForFrontOffice

      QueueEnablerAdminSession getQueueEnablerAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler administration service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueEnablerAdminSession
      Throws:
      NotFoundException - no front office found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueEnablerNotificationSession

      QueueEnablerNotificationSession getQueueEnablerNotificationSession(QueueEnablerReceiver queueEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the queue enabler notification service.
      Parameters:
      queueEnablerReceiver - the notification callback
      Returns:
      a QueueEnablerNotificationSession
      Throws:
      NullArgumentException - queueReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerNotification()} is {@code true} .

    • getQueueEnablerNotificationSessionForFrontOffice

      QueueEnablerNotificationSession getQueueEnablerNotificationSessionForFrontOffice(QueueEnablerReceiver queueEnablerReceiver, Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler notification service for the given front office.
      Parameters:
      queueEnablerReceiver - the notification callback
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueEnablerNotificationSession
      Throws:
      NotFoundException - no front office found by the given Id
      NullArgumentException - queueEnablerReceiver or frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueEnablerFrontOfficeSession

      QueueEnablerFrontOfficeSession getQueueEnablerFrontOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup queue enabler/front office mappings.
      Returns:
      a QueueEnablerFrontOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerFrontOffice()} is {@code true} .

    • getQueueEnablerFrontOfficeAssignmentSession

      QueueEnablerFrontOfficeAssignmentSession getQueueEnablerFrontOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning queue enablers to front offices.
      Returns:
      a QueueEnablerFrontOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerFrontOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerFrontOfficeAssignment()} is {@code true} .

    • getQueueEnablerSmartFrontOfficeSession

      QueueEnablerSmartFrontOfficeSession getQueueEnablerSmartFrontOfficeSession(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue enabler smart front offices.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueEnablerSmartFrontOfficeSession
      Throws:
      NotFoundException - no front office found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerSmartFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerSmartFrontOffice()} is {@code true} .

    • getQueueEnablerRuleLookupSession

      QueueEnablerRuleLookupSession getQueueEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue enabler queue mapping lookup service for looking up the rules applied to a queue.
      Returns:
      a QueueEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerRuleLookup()} is {@code true} .

    • getQueueEnablerRuleLookupSessionForFrontOffice

      QueueEnablerRuleLookupSession getQueueEnablerRuleLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler mapping lookup service for the given front office for looking up rules applied to a queue.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueEnablerRuleLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueEnablerRuleApplicationSession

      QueueEnablerRuleApplicationSession getQueueEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer assignment service to apply to queues.
      Returns:
      a QueueEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerRuleApplication()} is {@code true} .

    • getQueueEnablerRuleApplicationSessionForFrontOffice

      QueueEnablerRuleApplicationSession getQueueEnablerRuleApplicationSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue enabler assignment service for the given front office to apply to queues.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueEnablerRuleApplicationSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerLookupSession

      QueueConstrainerLookupSession getQueueConstrainerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer lookup service.
      Returns:
      a QueueConstrainerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerLookup()} is {@code true} .

    • getQueueConstrainerLookupSessionForFrontOffice

      QueueConstrainerLookupSession getQueueConstrainerLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer lookup service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerQuerySession

      QueueConstrainerQuerySession getQueueConstrainerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer query service.
      Returns:
      a QueueConstrainerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerQuery()} is {@code true} .

    • getQueueConstrainerQuerySessionForFrontOffice

      QueueConstrainerQuerySession getQueueConstrainerQuerySessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer query service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerQuerySession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerSearchSession

      QueueConstrainerSearchSession getQueueConstrainerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer search service.
      Returns:
      a QueueConstrainerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerSearch()} is {@code true} .

    • getQueueConstrainerSearchSessionForFrontOffice

      QueueConstrainerSearchSession getQueueConstrainerSearchSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer earch service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerSearchSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerAdminSession

      QueueConstrainerAdminSession getQueueConstrainerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer administration service.
      Returns:
      a QueueConstrainerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerAdmin()} is {@code true} .

    • getQueueConstrainerAdminSessionForFrontOffice

      QueueConstrainerAdminSession getQueueConstrainerAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer administration service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerAdminSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerNotificationSession

      QueueConstrainerNotificationSession getQueueConstrainerNotificationSession(QueueConstrainerReceiver queueConstrainerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer notification service.
      Parameters:
      queueConstrainerReceiver - the notification callback
      Returns:
      a QueueConstrainerNotificationSession
      Throws:
      NullArgumentException - queueConstrainerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerNotification()} is {@code true} .

    • getQueueConstrainerNotificationSessionForFrontOffice

      QueueConstrainerNotificationSession getQueueConstrainerNotificationSessionForFrontOffice(QueueConstrainerReceiver queueConstrainerReceiver, Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer notification service for the given front office.
      Parameters:
      queueConstrainerReceiver - the notification callback
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerNotificationSession
      Throws:
      NotFoundException - no front office found by the given Id
      NullArgumentException - queueConstrainerReceiver or frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerFrontOfficeSession

      QueueConstrainerFrontOfficeSession getQueueConstrainerFrontOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup queue constrainer/office mappings for queue constrainers.
      Returns:
      a QueueConstrainerFrontOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerFrontOffice()} is {@code true} .

    • getQueueConstrainerFrontOfficeAssignmentSession

      QueueConstrainerFrontOfficeAssignmentSession getQueueConstrainerFrontOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning queue constrainer to front office.
      Returns:
      a QueueConstrainerFrontOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerFrontOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerFrontOfficeAssignment()} is {@code true} .

    • getQueueConstrainerSmartFrontOfficeSession

      QueueConstrainerSmartFrontOfficeSession getQueueConstrainerSmartFrontOfficeSession(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue constrainer smart front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerSmartFrontOfficeSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerSmartFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerSmartFrontOffice()} is {@code true} .

    • getQueueConstrainerRuleLookupSession

      QueueConstrainerRuleLookupSession getQueueConstrainerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer mapping lookup service for looking up the rules applied to a queue.
      Returns:
      a QueueConstrainerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerRuleLookup()} is {@code true} .

    • getQueueConstrainerRuleLookupSessionForFrontOffice

      QueueConstrainerRuleLookupSession getQueueConstrainerRuleLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer mapping lookup service for the given front office for looking up rules applied to a queue.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerRuleLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerRuleApplicationSession

      QueueConstrainerRuleApplicationSession getQueueConstrainerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer assignment service to apply to queues.
      Returns:
      a QueueConstrainerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerRuleApplication()} is {@code true} .

    • getQueueConstrainerRuleApplicationSessionForFrontOffice

      QueueConstrainerRuleApplicationSession getQueueConstrainerRuleApplicationSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer assignment service for the given front office to apply to queues.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerRuleApplicationSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerEnablerLookupSession

      QueueConstrainerEnablerLookupSession getQueueConstrainerEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler lookup service.
      Returns:
      a QueueConstrainerEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerLookup()} is {@code true} .

    • getQueueConstrainerEnablerLookupSessionForFrontOffice

      QueueConstrainerEnablerLookupSession getQueueConstrainerEnablerLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler lookup service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerEnablerLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerEnablerQuerySession

      QueueConstrainerEnablerQuerySession getQueueConstrainerEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler query service.
      Returns:
      a QueueConstrainerEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerQuery()} is {@code true} .

    • getQueueConstrainerEnablerQuerySessionForFrontOffice

      QueueConstrainerEnablerQuerySession getQueueConstrainerEnablerQuerySessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler query service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerEnablerQuerySession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerEnablerSearchSession

      QueueConstrainerEnablerSearchSession getQueueConstrainerEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler search service.
      Returns:
      a QueueConstrainerEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerSearch()} is {@code true} .

    • getQueueConstrainerEnablerSearchSessionForFrontOffice

      QueueConstrainerEnablerSearchSession getQueueConstrainerEnablerSearchSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enablers earch service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerEnablerSearchSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerEnablerAdminSession

      QueueConstrainerEnablerAdminSession getQueueConstrainerEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler administration service.
      Returns:
      a QueueConstrainerEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerAdmin()} is {@code true} .

    • getQueueConstrainerEnablerAdminSessionForFrontOffice

      QueueConstrainerEnablerAdminSession getQueueConstrainerEnablerAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler administration service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerEnablerAdminSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerEnablerNotificationSession

      QueueConstrainerEnablerNotificationSession getQueueConstrainerEnablerNotificationSession(QueueConstrainerEnablerReceiver queueConstrainerEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler notification service.
      Parameters:
      queueConstrainerEnablerReceiver - the notification callback
      Returns:
      a QueueConstrainerEnablerNotificationSession
      Throws:
      NullArgumentException - queueConstrainerEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerNotification()} is {@code true} .

    • getQueueConstrainerEnablerNotificationSessionForFrontOffice

      QueueConstrainerEnablerNotificationSession getQueueConstrainerEnablerNotificationSessionForFrontOffice(QueueConstrainerEnablerReceiver queueConstrainerEnablerReceiver, Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler notification service for the given front office.
      Parameters:
      queueConstrainerEnablerReceiver - the notification callback
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerEnablerNotificationSession
      Throws:
      NotFoundException - no front office found by the given Id
      NullArgumentException - queueConstrainerEnablerReceiver or frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerEnablerFrontOfficeSession

      QueueConstrainerEnablerFrontOfficeSession getQueueConstrainerEnablerFrontOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup queue constrainer enabler/office mappings for queue constrainer enablers.
      Returns:
      a QueueConstrainerEnablerFrontOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerFrontOffice()} is {@code true} .

    • getQueueConstrainerEnablerFrontOfficeAssignmentSession

      QueueConstrainerEnablerFrontOfficeAssignmentSession getQueueConstrainerEnablerFrontOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning queue constrainer enablers to front office.
      Returns:
      a QueueConstrainerEnablerFrontOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerFrontOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerFrontOfficeAssignment()} is {@code true} .

    • getQueueConstrainerEnablerSmartFrontOfficeSession

      QueueConstrainerEnablerSmartFrontOfficeSession getQueueConstrainerEnablerSmartFrontOfficeSession(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue constrainer enabler smart front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerEnablerSmartFrontOfficeSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerSmartFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerSmartFrontOffice()} is {@code true} .

    • getQueueConstrainerEnablerRuleLookupSession

      QueueConstrainerEnablerRuleLookupSession getQueueConstrainerEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler mapping lookup service.
      Returns:
      a QueueConstrainerEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerRuleLookup()} is {@code true} .

    • getQueueConstrainerEnablerRuleLookupSessionForFrontOffice

      QueueConstrainerEnablerRuleLookupSession getQueueConstrainerEnablerRuleLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler mapping lookup service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerEnablerRuleLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueConstrainerEnablerRuleApplicationSession

      QueueConstrainerEnablerRuleApplicationSession getQueueConstrainerEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler assignment service.
      Returns:
      a QueueConstrainerEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerRuleApplication()} is {@code true} .

    • getQueueConstrainerEnablerRuleApplicationSessionForFrontOffice

      QueueConstrainerEnablerRuleApplicationSession getQueueConstrainerEnablerRuleApplicationSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue constrainer enabler assignment service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueConstrainerEnablerRuleApplicationSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueConstrainerEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorLookupSession

      QueueProcessorLookupSession getQueueProcessorLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor lookup service.
      Returns:
      a QueueProcessorLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorLookup()} is {@code true} .

    • getQueueProcessorLookupSessionForFrontOffice

      QueueProcessorLookupSession getQueueProcessorLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor lookup service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorQuerySession

      QueueProcessorQuerySession getQueueProcessorQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor query service.
      Returns:
      a QueueProcessorQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorQuery()} is {@code true} .

    • getQueueProcessorQuerySessionForFrontOffice

      QueueProcessorQuerySession getQueueProcessorQuerySessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor query service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorQuerySession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorSearchSession

      QueueProcessorSearchSession getQueueProcessorSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor search service.
      Returns:
      a QueueProcessorSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorSearch()} is {@code true} .

    • getQueueProcessorSearchSessionForFrontOffice

      QueueProcessorSearchSession getQueueProcessorSearchSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor earch service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorSearchSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorAdminSession

      QueueProcessorAdminSession getQueueProcessorAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor administration service.
      Returns:
      a QueueProcessorAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorAdmin()} is {@code true} .

    • getQueueProcessorAdminSessionForFrontOffice

      QueueProcessorAdminSession getQueueProcessorAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor administration service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorAdminSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorNotificationSession

      QueueProcessorNotificationSession getQueueProcessorNotificationSession(QueueProcessorReceiver queueProcessorReceiver) throws OperationFailedException
      Gets the OsidSession associated with the queue processor notification service.
      Parameters:
      queueProcessorReceiver - the notification callback
      Returns:
      a QueueProcessorNotificationSession
      Throws:
      NullArgumentException - queueProcessorReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorNotification()} is {@code true} .

    • getQueueProcessorNotificationSessionForFrontOffice

      QueueProcessorNotificationSession getQueueProcessorNotificationSessionForFrontOffice(QueueProcessorReceiver queueProcessorReceiver, Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor notification service for the given front office.
      Parameters:
      queueProcessorReceiver - the notification callback
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorNotificationSession
      Throws:
      NotFoundException - no front office found by the given Id
      NullArgumentException - queueProcessorReceiver or frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorFrontOfficeSession

      QueueProcessorFrontOfficeSession getQueueProcessorFrontOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup queue processor/office mappings for queue processors.
      Returns:
      a QueueProcessorFrontOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorFrontOffice()} is {@code true} .

    • getQueueProcessorFrontOfficeAssignmentSession

      QueueProcessorFrontOfficeAssignmentSession getQueueProcessorFrontOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning queue processor to front office.
      Returns:
      a QueueProcessorFrontOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorFrontOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorFrontOfficeAssignment()} is {@code true} .

    • getQueueProcessorSmartFrontOfficeSession

      QueueProcessorSmartFrontOfficeSession getQueueProcessorSmartFrontOfficeSession(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue processor smart front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorSmartFrontOfficeSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorSmartFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorSmartFrontOffice()} is {@code true} .

    • getQueueProcessorRuleLookupSession

      QueueProcessorRuleLookupSession getQueueProcessorRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor mapping lookup service for looking up the rules applied to a queue.
      Returns:
      a QueueProcessorRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorRuleLookup()} is {@code true} .

    • getQueueProcessorRuleLookupSessionForFrontOffice

      QueueProcessorRuleLookupSession getQueueProcessorRuleLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor mapping lookup service for the given front office for looking up rules applied to a queue.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorRuleLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorRuleApplicationSession

      QueueProcessorRuleApplicationSession getQueueProcessorRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor assignment service.
      Returns:
      a QueueProcessorRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorRuleApplication()} is {@code true} .

    • getQueueProcessorRuleApplicationSessionForFrontOffice

      QueueProcessorRuleApplicationSession getQueueProcessorRuleApplicationSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor assignment service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorRuleApplicationSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorEnablerLookupSession

      QueueProcessorEnablerLookupSession getQueueProcessorEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler lookup service.
      Returns:
      a QueueProcessorEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerLookup()} is {@code true} .

    • getQueueProcessorEnablerLookupSessionForFrontOffice

      QueueProcessorEnablerLookupSession getQueueProcessorEnablerLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler lookup service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorEnablerLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorEnablerQuerySession

      QueueProcessorEnablerQuerySession getQueueProcessorEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler query service.
      Returns:
      a QueueProcessorEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerQuery()} is {@code true} .

    • getQueueProcessorEnablerQuerySessionForFrontOffice

      QueueProcessorEnablerQuerySession getQueueProcessorEnablerQuerySessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler query service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorEnablerQuerySession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorEnablerSearchSession

      QueueProcessorEnablerSearchSession getQueueProcessorEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler search service.
      Returns:
      a QueueProcessorEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerSearch()} is {@code true} .

    • getQueueProcessorEnablerSearchSessionForFrontOffice

      QueueProcessorEnablerSearchSession getQueueProcessorEnablerSearchSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enablers earch service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorEnablerSearchSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorEnablerAdminSession

      QueueProcessorEnablerAdminSession getQueueProcessorEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler administration service.
      Returns:
      a QueueProcessorEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerAdmin()} is {@code true} .

    • getQueueProcessorEnablerAdminSessionForFrontOffice

      QueueProcessorEnablerAdminSession getQueueProcessorEnablerAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler administration service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorEnablerAdminSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorEnablerNotificationSession

      QueueProcessorEnablerNotificationSession getQueueProcessorEnablerNotificationSession(QueueProcessorEnablerReceiver queueProcessorEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler notification service.
      Parameters:
      queueProcessorEnablerReceiver - the notification callback
      Returns:
      a QueueProcessorEnablerNotificationSession
      Throws:
      NullArgumentException - queueProcessorEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerNotification()} is {@code true} .

    • getQueueProcessorEnablerNotificationSessionForFrontOffice

      QueueProcessorEnablerNotificationSession getQueueProcessorEnablerNotificationSessionForFrontOffice(QueueProcessorEnablerReceiver queueProcessorEnablerReceiver, Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler notification service for the given front office.
      Parameters:
      queueProcessorEnablerReceiver - the notification callback
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorEnablerNotificationSession
      Throws:
      NotFoundException - no front office found by the given Id
      NullArgumentException - queueProcessorEnablerReceiver or frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorEnablerFrontOfficeSession

      QueueProcessorEnablerFrontOfficeSession getQueueProcessorEnablerFrontOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup queue processor enabler/office mappings for queue processor enablers.
      Returns:
      a QueueProcessorEnablerFrontOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerFrontOffice()} is {@code true} .

    • getQueueProcessorEnablerFrontOfficeAssignmentSession

      QueueProcessorEnablerFrontOfficeAssignmentSession getQueueProcessorEnablerFrontOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning queue processor enablers to front office.
      Returns:
      a QueueProcessorEnablerFrontOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerFrontOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerFrontOfficeAssignment()} is {@code true} .

    • getQueueProcessorEnablerSmartFrontOfficeSession

      QueueProcessorEnablerSmartFrontOfficeSession getQueueProcessorEnablerSmartFrontOfficeSession(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage queue processor enabler smart front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorEnablerSmartFrontOfficeSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerSmartFrontOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerSmartFrontOffice()} is {@code true} .

    • getQueueProcessorEnablerRuleLookupSession

      QueueProcessorEnablerRuleLookupSession getQueueProcessorEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler mapping lookup service.
      Returns:
      a QueueProcessorEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerRuleLookup()} is {@code true} .

    • getQueueProcessorEnablerRuleLookupSessionForFrontOffice

      QueueProcessorEnablerRuleLookupSession getQueueProcessorEnablerRuleLookupSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler mapping lookup service.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorEnablerRuleLookupSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getQueueProcessorEnablerRuleApplicationSession

      QueueProcessorEnablerRuleApplicationSession getQueueProcessorEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the queue processor enabler assignment service.
      Returns:
      a QueueProcessorEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerRuleApplication()} is {@code true} .

    • getQueueProcessorEnablerRuleApplicationSessionForFrontOffice

      QueueProcessorEnablerRuleApplicationSession getQueueProcessorEnablerRuleApplicationSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the queue processor enabler assignment service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueProcessorEnablerRuleApplicationSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueProcessorEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .