OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.rules.TrackingRulesManager
Implementsosid.OsidManager
osid.tracking.rules.TrackingRulesProfile
Description

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:

  • 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
MethodgetQueueConstrainerLookupSession
Description

Gets the OsidSession associated with the queue constrainer lookup service.

Returnosid.tracking.rules.QueueConstrainerLookupSessiona QueueConstrainerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerLookup() is true.
MethodgetQueueConstrainerLookupSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer lookup service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerLookupSessiona QueueConstrainerLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerLookup() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerQuerySession
Description

Gets the OsidSession associated with the queue constrainer query service.

Returnosid.tracking.rules.QueueConstrainerQuerySessiona QueueConstrainerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerQuery() is true.
MethodgetQueueConstrainerQuerySessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer query service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerQuerySessiona QueueConstrainerQuerySession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerQuery() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerSearchSession
Description

Gets the OsidSession associated with the queue constrainer search service.

Returnosid.tracking.rules.QueueConstrainerSearchSessiona QueueConstrainerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerSearch() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerSearch() is true.
MethodgetQueueConstrainerSearchSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer earch service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerSearchSessiona QueueConstrainerSearchSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerSearch() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerAdminSession
Description

Gets the OsidSession associated with the queue constrainer administration service.

Returnosid.tracking.rules.QueueConstrainerAdminSessiona QueueConstrainerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerAdmin() is true.
MethodgetQueueConstrainerAdminSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer administration service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerAdminSessiona QueueConstrainerAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerAdmin() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerNotificationSession
Description

Gets the OsidSession associated with the queue constrainer notification service.

Parametersosid.tracking.rules.QueueConstrainerReceiverqueueConstrainerReceiverthe notification callback
Returnosid.tracking.rules.QueueConstrainerNotificationSessiona QueueConstrainerNotificationSession
ErrorsNULL_ARGUMENT queueConstrainerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerNotification() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerNotification() is true.
MethodgetQueueConstrainerNotificationSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer notification service for the given front office.

Parametersosid.tracking.rules.QueueConstrainerReceiverqueueConstrainerReceiverthe notification callback
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerNotificationSessiona QueueConstrainerNotificationSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENT queueConstrainerReceiver or frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerNotification() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerFrontOfficeSession
Description

Gets the OsidSession to lookup queue constrainer/office mappings for queue constrainers.

Returnosid.tracking.rules.QueueConstrainerFrontOfficeSessiona QueueConstrainerFrontOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerFrontOffice() is true.
MethodgetQueueConstrainerFrontOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning queue constrainer to front office.

Returnosid.tracking.rules.QueueConstrainerFrontOfficeAssignmentSessiona QueueConstrainerFrontOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerFrontOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerFrontOfficeAssignment() is true.
MethodgetQueueConstrainerSmartFrontOfficeSession
Description

Gets the OsidSession to manage queue constrainer smart front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerSmartFrontOfficeSessiona QueueConstrainerSmartFrontOfficeSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerSmartFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerSmartFrontOffice() is true.
MethodgetQueueConstrainerRuleLookupSession
Description

Gets the OsidSession associated with the queue constrainer mapping lookup service for looking up the rules applied to a queue.

Returnosid.tracking.rules.QueueConstrainerRuleLookupSessiona QueueConstrainerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerRuleLookup() is true.
MethodgetQueueConstrainerRuleLookupSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer mapping lookup service for the given front office for looking up rules applied to a queue.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerRuleLookupSessiona QueueConstrainerRuleLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerRuleLookup() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerRuleApplicationSession
Description

Gets the OsidSession associated with the queue constrainer assignment service to apply to queues.

Returnosid.tracking.rules.QueueConstrainerRuleApplicationSessiona QueueConstrainerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerRuleApplication() is true.
MethodgetQueueConstrainerRuleApplicationSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer assignment service for the given front office to apply to queues.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerRuleApplicationSessiona QueueConstrainerRuleApplicationSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerRuleApplication() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerEnablerLookupSession
Description

Gets the OsidSession associated with the queue constrainer enabler lookup service.

Returnosid.tracking.rules.QueueConstrainerEnablerLookupSessiona QueueConstrainerEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerLookup() is true.
MethodgetQueueConstrainerEnablerLookupSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer enabler lookup service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerEnablerLookupSessiona QueueConstrainerEnablerLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerLookup() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerEnablerQuerySession
Description

Gets the OsidSession associated with the queue constrainer enabler query service.

Returnosid.tracking.rules.QueueConstrainerEnablerQuerySessiona QueueConstrainerEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerQuery() is true.
MethodgetQueueConstrainerEnablerQuerySessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer enabler query service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerEnablerQuerySessiona QueueConstrainerEnablerQuerySession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerQuery() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerEnablerSearchSession
Description

Gets the OsidSession associated with the queue constrainer enabler search service.

Returnosid.tracking.rules.QueueConstrainerEnablerSearchSessiona QueueConstrainerEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerSearch() is true.
MethodgetQueueConstrainerEnablerSearchSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer enablers earch service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerEnablerSearchSessiona QueueConstrainerEnablerSearchSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerSearch() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerEnablerAdminSession
Description

Gets the OsidSession associated with the queue constrainer enabler administration service.

Returnosid.tracking.rules.QueueConstrainerEnablerAdminSessiona QueueConstrainerEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerAdmin() is true.
MethodgetQueueConstrainerEnablerAdminSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer enabler administration service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerEnablerAdminSessiona QueueConstrainerEnablerAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerEnablerNotificationSession
Description

Gets the OsidSession associated with the queue constrainer enabler notification service.

Parametersosid.tracking.rules.QueueConstrainerEnablerReceiverqueueConstrainerEnablerReceiverthe notification callback
Returnosid.tracking.rules.QueueConstrainerEnablerNotificationSessiona QueueConstrainerEnablerNotificationSession
ErrorsNULL_ARGUMENT queueConstrainerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerNotification() is true.
MethodgetQueueConstrainerEnablerNotificationSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer enabler notification service for the given front office.

Parametersosid.tracking.rules.QueueConstrainerEnablerReceiverqueueConstrainerEnablerReceiverthe notification callback
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerEnablerNotificationSessiona QueueConstrainerEnablerNotificationSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENT queueConstrainerEnablerReceiver or frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerNotification() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerEnablerFrontOfficeSession
Description

Gets the OsidSession to lookup queue constrainer enabler/office mappings for queue constrainer enablers.

Returnosid.tracking.rules.QueueConstrainerEnablerFrontOfficeSessiona QueueConstrainerEnablerFrontOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerFrontOffice() is true.
MethodgetQueueConstrainerEnablerFrontOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning queue constrainer enablers to front office.

Returnosid.tracking.rules.QueueConstrainerEnablerFrontOfficeAssignmentSessiona QueueConstrainerEnablerFrontOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerFrontOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerFrontOfficeAssignment() is true.
MethodgetQueueConstrainerEnablerSmartFrontOfficeSession
Description

Gets the OsidSession to manage queue constrainer enabler smart front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerEnablerSmartFrontOfficeSessiona QueueConstrainerEnablerSmartFrontOfficeSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerSmartFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerSmartFrontOffice() is true.
MethodgetQueueConstrainerEnablerRuleLookupSession
Description

Gets the OsidSession associated with the queue constrainer enabler mapping lookup service.

Returnosid.tracking.rules.QueueConstrainerEnablerRuleLookupSessiona QueueConstrainerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerRuleLookup() is true.
MethodgetQueueConstrainerEnablerRuleLookupSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer enabler mapping lookup service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerEnablerRuleLookupSessiona QueueConstrainerEnablerRuleLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetQueueConstrainerEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the queue constrainer enabler assignment service.

Returnosid.tracking.rules.QueueConstrainerEnablerRuleApplicationSessiona QueueConstrainerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerRuleApplication() is true.
MethodgetQueueConstrainerEnablerRuleApplicationSessionForFrontOffice
Description

Gets the OsidSession associated with the queue constrainer enabler assignment service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerEnablerRuleApplicationSessiona QueueConstrainerEnablerRuleApplicationSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueConstrainerEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetQueueProcessorLookupSession
Description

Gets the OsidSession associated with the queue processor lookup service.

Returnosid.tracking.rules.QueueProcessorLookupSessiona QueueProcessorLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorLookup() is true.
MethodgetQueueProcessorLookupSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor lookup service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorLookupSessiona QueueProcessorLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorLookup() and supportsVisibleFederation() are true.
MethodgetQueueProcessorQuerySession
Description

Gets the OsidSession associated with the queue processor query service.

Returnosid.tracking.rules.QueueProcessorQuerySessiona QueueProcessorQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorQuery() is true.
MethodgetQueueProcessorQuerySessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor query service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorQuerySessiona QueueProcessorQuerySession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorQuery() and supportsVisibleFederation() are true.
MethodgetQueueProcessorSearchSession
Description

Gets the OsidSession associated with the queue processor search service.

Returnosid.tracking.rules.QueueProcessorSearchSessiona QueueProcessorSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorSearch() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorSearch() is true.
MethodgetQueueProcessorSearchSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor earch service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorSearchSessiona QueueProcessorSearchSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorSearch() and supportsVisibleFederation() are true.
MethodgetQueueProcessorAdminSession
Description

Gets the OsidSession associated with the queue processor administration service.

Returnosid.tracking.rules.QueueProcessorAdminSessiona QueueProcessorAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorAdmin() is true.
MethodgetQueueProcessorAdminSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor administration service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorAdminSessiona QueueProcessorAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorAdmin() and supportsVisibleFederation() are true.
MethodgetQueueProcessorNotificationSession
Description

Gets the OsidSession associated with the queue processor notification service.

Parametersosid.tracking.rules.QueueProcessorReceiverqueueProcessorReceiverthe notification callback
Returnosid.tracking.rules.QueueProcessorNotificationSessiona QueueProcessorNotificationSession
ErrorsNULL_ARGUMENT queueProcessorReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorNotification() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorNotification() is true.
MethodgetQueueProcessorNotificationSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor notification service for the given front office.

Parametersosid.tracking.rules.QueueProcessorReceiverqueueProcessorReceiverthe notification callback
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorNotificationSessiona QueueProcessorNotificationSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENT queueProcessorReceiver or frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorNotification() and supportsVisibleFederation() are true.
MethodgetQueueProcessorFrontOfficeSession
Description

Gets the OsidSession to lookup queue processor/office mappings for queue processors.

Returnosid.tracking.rules.QueueProcessorFrontOfficeSessiona QueueProcessorFrontOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorFrontOffice() is true.
MethodgetQueueProcessorFrontOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning queue processor to front office.

Returnosid.tracking.rules.QueueProcessorFrontOfficeAssignmentSessiona QueueProcessorFrontOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorFrontOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorFrontOfficeAssignment() is true.
MethodgetQueueProcessorSmartFrontOfficeSession
Description

Gets the OsidSession to manage queue processor smart front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorSmartFrontOfficeSessiona QueueProcessorSmartFrontOfficeSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorSmartFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorSmartFrontOffice() is true.
MethodgetQueueProcessorRuleLookupSession
Description

Gets the OsidSession associated with the queue processor mapping lookup service for looking up the rules applied to a queue.

Returnosid.tracking.rules.QueueProcessorRuleLookupSessiona QueueProcessorRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorRuleLookup() is true.
MethodgetQueueProcessorRuleLookupSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor mapping lookup service for the given front office for looking up rules applied to a queue.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorRuleLookupSessiona QueueProcessorRuleLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorRuleLookup() and supportsVisibleFederation() are true.
MethodgetQueueProcessorRuleApplicationSession
Description

Gets the OsidSession associated with the queue processor assignment service.

Returnosid.tracking.rules.QueueProcessorRuleApplicationSessiona QueueProcessorRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorRuleApplication() is true.
MethodgetQueueProcessorRuleApplicationSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor assignment service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorRuleApplicationSessiona QueueProcessorRuleApplicationSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorRuleApplication() and supportsVisibleFederation() are true.
MethodgetQueueProcessorEnablerLookupSession
Description

Gets the OsidSession associated with the queue processor enabler lookup service.

Returnosid.tracking.rules.QueueProcessorEnablerLookupSessiona QueueProcessorEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerLookup() is true.
MethodgetQueueProcessorEnablerLookupSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor enabler lookup service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorEnablerLookupSessiona QueueProcessorEnablerLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerLookup() and supportsVisibleFederation() are true.
MethodgetQueueProcessorEnablerQuerySession
Description

Gets the OsidSession associated with the queue processor enabler query service.

Returnosid.tracking.rules.QueueProcessorEnablerQuerySessiona QueueProcessorEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerQuery() is true.
MethodgetQueueProcessorEnablerQuerySessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor enabler query service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorEnablerQuerySessiona QueueProcessorEnablerQuerySession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerQuery() and supportsVisibleFederation() are true.
MethodgetQueueProcessorEnablerSearchSession
Description

Gets the OsidSession associated with the queue processor enabler search service.

Returnosid.tracking.rules.QueueProcessorEnablerSearchSessiona QueueProcessorEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerSearch() is true.
MethodgetQueueProcessorEnablerSearchSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor enablers earch service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorEnablerSearchSessiona QueueProcessorEnablerSearchSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerSearch() and supportsVisibleFederation() are true.
MethodgetQueueProcessorEnablerAdminSession
Description

Gets the OsidSession associated with the queue processor enabler administration service.

Returnosid.tracking.rules.QueueProcessorEnablerAdminSessiona QueueProcessorEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerAdmin() is true.
MethodgetQueueProcessorEnablerAdminSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor enabler administration service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorEnablerAdminSessiona QueueProcessorEnablerAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetQueueProcessorEnablerNotificationSession
Description

Gets the OsidSession associated with the queue processor enabler notification service.

Parametersosid.tracking.rules.QueueProcessorEnablerReceiverqueueProcessorEnablerReceiverthe notification callback
Returnosid.tracking.rules.QueueProcessorEnablerNotificationSessiona QueueProcessorEnablerNotificationSession
ErrorsNULL_ARGUMENT queueProcessorEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerNotification() is true.
MethodgetQueueProcessorEnablerNotificationSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor enabler notification service for the given front office.

Parametersosid.tracking.rules.QueueProcessorEnablerReceiverqueueProcessorEnablerReceiverthe notification callback
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorEnablerNotificationSessiona QueueProcessorEnablerNotificationSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENT queueProcessorEnablerReceiver or frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerNotification() and supportsVisibleFederation() are true.
MethodgetQueueProcessorEnablerFrontOfficeSession
Description

Gets the OsidSession to lookup queue processor enabler/office mappings for queue processor enablers.

Returnosid.tracking.rules.QueueProcessorEnablerFrontOfficeSessiona QueueProcessorEnablerFrontOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerFrontOffice() is true.
MethodgetQueueProcessorEnablerFrontOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning queue processor enablers to front office.

Returnosid.tracking.rules.QueueProcessorEnablerFrontOfficeAssignmentSessiona QueueProcessorEnablerFrontOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerFrontOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerFrontOfficeAssignment() is true.
MethodgetQueueProcessorEnablerSmartFrontOfficeSession
Description

Gets the OsidSession to manage queue processor enabler smart front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorEnablerSmartFrontOfficeSessiona QueueProcessorEnablerSmartFrontOfficeSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerSmartFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerSmartFrontOffice() is true.
MethodgetQueueProcessorEnablerRuleLookupSession
Description

Gets the OsidSession associated with the queue processor enabler mapping lookup service.

Returnosid.tracking.rules.QueueProcessorEnablerRuleLookupSessiona QueueProcessorEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerRuleLookup() is true.
MethodgetQueueProcessorEnablerRuleLookupSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor enabler mapping lookup service.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorEnablerRuleLookupSessiona QueueProcessorEnablerRuleLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetQueueProcessorEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the queue processor enabler assignment service.

Returnosid.tracking.rules.QueueProcessorEnablerRuleApplicationSessiona QueueProcessorEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerRuleApplication() is true.
MethodgetQueueProcessorEnablerRuleApplicationSessionForFrontOffice
Description

Gets the OsidSession associated with the queue processor enabler assignment service for the given front office.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.rules.QueueProcessorEnablerRuleApplicationSessiona QueueProcessorEnablerRuleApplicationSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueProcessorEnablerRuleApplication() and supportsVisibleFederation() are true.