| Interface | osid.tracking.rules.TrackingRulesManager | ||
|---|---|---|---|
| Implements | osid.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:
| ||
| Method | getQueueConstrainerLookupSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerLookupSession | a QueueConstrainerLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueConstrainerLookup()
is true. | |
| Method | getQueueConstrainerLookupSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerLookupSession | a QueueConstrainerLookupSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueConstrainerLookup()
and supportsVisibleFederation() are true.
| |
| Method | getQueueConstrainerQuerySession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerQuerySession | a QueueConstrainerQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueConstrainerQuery()
is true. | |
| Method | getQueueConstrainerQuerySessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerQuerySession | a QueueConstrainerQuerySession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueConstrainerQuery()
and supportsVisibleFederation() are true.
| |
| Method | getQueueConstrainerSearchSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerSearchSession | a QueueConstrainerSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueConstrainerSearch()
is true. | |
| Method | getQueueConstrainerSearchSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerSearchSession | a QueueConstrainerSearchSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueConstrainerSearch()
and supportsVisibleFederation() are true.
| |
| Method | getQueueConstrainerAdminSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerAdminSession | a QueueConstrainerAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueConstrainerAdmin()
is true. | |
| Method | getQueueConstrainerAdminSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerAdminSession | a QueueConstrainerAdminSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueConstrainerAdmin()
and supportsVisibleFederation() are true.
| |
| Method | getQueueConstrainerNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.tracking.rules.QueueConstrainerReceiver | queueConstrainerReceiver | the notification callback |
| Return | osid.tracking.rules.QueueConstrainerNotificationSession | a QueueConstrainerNotificationSession | |
| Errors | NULL_ARGUMENT | queueConstrainerReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerNotification() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerNotification() is true. | |
| Method | getQueueConstrainerNotificationSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.tracking.rules.QueueConstrainerReceiver | queueConstrainerReceiver | the notification callback |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Return | osid.tracking.rules.QueueConstrainerNotificationSession | a QueueConstrainerNotificationSession | |
| Errors | NOT_FOUND | no front office found by the given Id | |
| NULL_ARGUMENT | queueConstrainerReceiver or frontOfficeId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerNotification() and
supportsVisibleFederation() are true. | |
| Method | getQueueConstrainerFrontOfficeSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerFrontOfficeSession | a QueueConstrainerFrontOfficeSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerFrontOffice() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerFrontOffice() is true. | |
| Method | getQueueConstrainerFrontOfficeAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerFrontOfficeAssignmentSession | a QueueConstrainerFrontOfficeAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerFrontOfficeAssignment() is
false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerFrontOfficeAssignment() is true.
| |
| Method | getQueueConstrainerSmartFrontOfficeSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerSmartFrontOfficeSession | a QueueConstrainerSmartFrontOfficeSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerSmartFrontOffice() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerSmartFrontOffice() is true. | |
| Method | getQueueConstrainerRuleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerRuleLookupSession | a QueueConstrainerRuleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerRuleLookup() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerRuleLookup() is true. | |
| Method | getQueueConstrainerRuleLookupSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerRuleLookupSession | a QueueConstrainerRuleLookupSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerRuleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerRuleLookup() and
supportsVisibleFederation() are true. | |
| Method | getQueueConstrainerRuleApplicationSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerRuleApplicationSession | a QueueConstrainerRuleApplicationSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerRuleApplication() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerRuleApplication() is true. | |
| Method | getQueueConstrainerRuleApplicationSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerRuleApplicationSession | a QueueConstrainerRuleApplicationSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerRuleApplication() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerRuleApplication() and
supportsVisibleFederation() are true. | |
| Method | getQueueConstrainerEnablerLookupSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerEnablerLookupSession | a QueueConstrainerEnablerLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerEnablerLookup() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerLookup() is true. | |
| Method | getQueueConstrainerEnablerLookupSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerEnablerLookupSession | a QueueConstrainerEnablerLookupSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerEnablerLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerLookup() and
supportsVisibleFederation() are true. | |
| Method | getQueueConstrainerEnablerQuerySession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerEnablerQuerySession | a QueueConstrainerEnablerQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerEnablerQuery() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerQuery() is true. | |
| Method | getQueueConstrainerEnablerQuerySessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerEnablerQuerySession | a QueueConstrainerEnablerQuerySession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerEnablerQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerQuery() and
supportsVisibleFederation() are true. | |
| Method | getQueueConstrainerEnablerSearchSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerEnablerSearchSession | a QueueConstrainerEnablerSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerEnablerSearch() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerSearch() is true. | |
| Method | getQueueConstrainerEnablerSearchSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerEnablerSearchSession | a QueueConstrainerEnablerSearchSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerEnablerSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerSearch() and
supportsVisibleFederation() are true. | |
| Method | getQueueConstrainerEnablerAdminSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerEnablerAdminSession | a QueueConstrainerEnablerAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerEnablerAdmin() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerAdmin() is true. | |
| Method | getQueueConstrainerEnablerAdminSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerEnablerAdminSession | a QueueConstrainerEnablerAdminSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerEnablerAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerAdmin() and
supportsVisibleFederation() are true. | |
| Method | getQueueConstrainerEnablerNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.tracking.rules.QueueConstrainerEnablerReceiver | queueConstrainerEnablerReceiver | the notification callback |
| Return | osid.tracking.rules.QueueConstrainerEnablerNotificationSession | a QueueConstrainerEnablerNotificationSession | |
| Errors | NULL_ARGUMENT | queueConstrainerEnablerReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerEnablerNotification() is
false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerNotification() is true. | |
| Method | getQueueConstrainerEnablerNotificationSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.tracking.rules.QueueConstrainerEnablerReceiver | queueConstrainerEnablerReceiver | the notification callback |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Return | osid.tracking.rules.QueueConstrainerEnablerNotificationSession | a QueueConstrainerEnablerNotificationSession | |
| Errors | NOT_FOUND | no front office found by the given Id | |
| NULL_ARGUMENT | queueConstrainerEnablerReceiver or frontOfficeId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerEnablerNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerNotification() and
supportsVisibleFederation() are true. | |
| Method | getQueueConstrainerEnablerFrontOfficeSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerEnablerFrontOfficeSession | a QueueConstrainerEnablerFrontOfficeSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerEnablerFrontOffice() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerFrontOffice() is true. | |
| Method | getQueueConstrainerEnablerFrontOfficeAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerEnablerFrontOfficeAssignmentSession | a QueueConstrainerEnablerFrontOfficeAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerEnablerFrontOfficeAssignment() is
false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerFrontOfficeAssignment() is true.
| |
| Method | getQueueConstrainerEnablerSmartFrontOfficeSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerEnablerSmartFrontOfficeSession | a QueueConstrainerEnablerSmartFrontOfficeSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerEnablerSmartFrontOffice() is
false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerSmartFrontOffice() is true.
| |
| Method | getQueueConstrainerEnablerRuleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerEnablerRuleLookupSession | a QueueConstrainerEnablerRuleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerEnablerRuleLookup() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerRuleLookup() is true. | |
| Method | getQueueConstrainerEnablerRuleLookupSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerEnablerRuleLookupSession | a QueueConstrainerEnablerRuleLookupSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
| Method | getQueueConstrainerEnablerRuleApplicationSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueConstrainerEnablerRuleApplicationSession | a QueueConstrainerEnablerRuleApplicationSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueConstrainerEnablerRuleApplication() is
false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerRuleApplication() is true.
| |
| Method | getQueueConstrainerEnablerRuleApplicationSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueConstrainerEnablerRuleApplicationSession | a QueueConstrainerEnablerRuleApplicationSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueConstrainerEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueConstrainerEnablerRuleApplication() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorLookupSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorLookupSession | a QueueProcessorLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueProcessorLookup()
is true. | |
| Method | getQueueProcessorLookupSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorLookupSession | a QueueProcessorLookupSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueProcessorLookup()
and supportsVisibleFederation() are true.
| |
| Method | getQueueProcessorQuerySession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorQuerySession | a QueueProcessorQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueProcessorQuery()
is true. | |
| Method | getQueueProcessorQuerySessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorQuerySession | a QueueProcessorQuerySession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueProcessorQuery()
and supportsVisibleFederation() are true.
| |
| Method | getQueueProcessorSearchSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorSearchSession | a QueueProcessorSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueProcessorSearch()
is true. | |
| Method | getQueueProcessorSearchSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorSearchSession | a QueueProcessorSearchSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueProcessorSearch()
and supportsVisibleFederation() are true.
| |
| Method | getQueueProcessorAdminSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorAdminSession | a QueueProcessorAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueProcessorAdmin()
is true. | |
| Method | getQueueProcessorAdminSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorAdminSession | a QueueProcessorAdminSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQueueProcessorAdmin()
and supportsVisibleFederation() are true.
| |
| Method | getQueueProcessorNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.tracking.rules.QueueProcessorReceiver | queueProcessorReceiver | the notification callback |
| Return | osid.tracking.rules.QueueProcessorNotificationSession | a QueueProcessorNotificationSession | |
| Errors | NULL_ARGUMENT | queueProcessorReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorNotification() is true. | |
| Method | getQueueProcessorNotificationSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.tracking.rules.QueueProcessorReceiver | queueProcessorReceiver | the notification callback |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Return | osid.tracking.rules.QueueProcessorNotificationSession | a QueueProcessorNotificationSession | |
| Errors | NOT_FOUND | no front office found by the given Id | |
| NULL_ARGUMENT | queueProcessorReceiver or frontOfficeId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorNotification() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorFrontOfficeSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorFrontOfficeSession | a QueueProcessorFrontOfficeSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorFrontOffice() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorFrontOffice() is true. | |
| Method | getQueueProcessorFrontOfficeAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorFrontOfficeAssignmentSession | a QueueProcessorFrontOfficeAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorFrontOfficeAssignment() is
false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorFrontOfficeAssignment() is true. | |
| Method | getQueueProcessorSmartFrontOfficeSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorSmartFrontOfficeSession | a QueueProcessorSmartFrontOfficeSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorSmartFrontOffice() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorSmartFrontOffice() is true. | |
| Method | getQueueProcessorRuleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorRuleLookupSession | a QueueProcessorRuleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorRuleLookup() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorRuleLookup() is true. | |
| Method | getQueueProcessorRuleLookupSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorRuleLookupSession | a QueueProcessorRuleLookupSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorRuleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorRuleLookup() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorRuleApplicationSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorRuleApplicationSession | a QueueProcessorRuleApplicationSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorRuleApplication() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorRuleApplication() is true. | |
| Method | getQueueProcessorRuleApplicationSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorRuleApplicationSession | a QueueProcessorRuleApplicationSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorRuleApplication() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorRuleApplication() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorEnablerLookupSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorEnablerLookupSession | a QueueProcessorEnablerLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorEnablerLookup() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerLookup() is true. | |
| Method | getQueueProcessorEnablerLookupSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorEnablerLookupSession | a QueueProcessorEnablerLookupSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorEnablerLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerLookup() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorEnablerQuerySession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorEnablerQuerySession | a QueueProcessorEnablerQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorEnablerQuery() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerQuery() is true. | |
| Method | getQueueProcessorEnablerQuerySessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorEnablerQuerySession | a QueueProcessorEnablerQuerySession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorEnablerQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerQuery() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorEnablerSearchSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorEnablerSearchSession | a QueueProcessorEnablerSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorEnablerSearch() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerSearch() is true. | |
| Method | getQueueProcessorEnablerSearchSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorEnablerSearchSession | a QueueProcessorEnablerSearchSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorEnablerSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerSearch() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorEnablerAdminSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorEnablerAdminSession | a QueueProcessorEnablerAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorEnablerAdmin() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerAdmin() is true. | |
| Method | getQueueProcessorEnablerAdminSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorEnablerAdminSession | a QueueProcessorEnablerAdminSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorEnablerAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerAdmin() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorEnablerNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.tracking.rules.QueueProcessorEnablerReceiver | queueProcessorEnablerReceiver | the notification callback |
| Return | osid.tracking.rules.QueueProcessorEnablerNotificationSession | a QueueProcessorEnablerNotificationSession | |
| Errors | NULL_ARGUMENT | queueProcessorEnablerReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorEnablerNotification() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerNotification() is true. | |
| Method | getQueueProcessorEnablerNotificationSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.tracking.rules.QueueProcessorEnablerReceiver | queueProcessorEnablerReceiver | the notification callback |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Return | osid.tracking.rules.QueueProcessorEnablerNotificationSession | a QueueProcessorEnablerNotificationSession | |
| Errors | NOT_FOUND | no front office found by the given Id | |
| NULL_ARGUMENT | queueProcessorEnablerReceiver or frontOfficeId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorEnablerNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerNotification() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorEnablerFrontOfficeSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorEnablerFrontOfficeSession | a QueueProcessorEnablerFrontOfficeSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorEnablerFrontOffice() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerFrontOffice() is true. | |
| Method | getQueueProcessorEnablerFrontOfficeAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorEnablerFrontOfficeAssignmentSession | a QueueProcessorEnablerFrontOfficeAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorEnablerFrontOfficeAssignment() is
false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerFrontOfficeAssignment() is true.
| |
| Method | getQueueProcessorEnablerSmartFrontOfficeSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorEnablerSmartFrontOfficeSession | a QueueProcessorEnablerSmartFrontOfficeSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorEnablerSmartFrontOffice() is
false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerSmartFrontOffice() is true.
| |
| Method | getQueueProcessorEnablerRuleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorEnablerRuleLookupSession | a QueueProcessorEnablerRuleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorEnablerRuleLookup() is false
| ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerRuleLookup() is true. | |
| Method | getQueueProcessorEnablerRuleLookupSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorEnablerRuleLookupSession | a QueueProcessorEnablerRuleLookupSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
| Method | getQueueProcessorEnablerRuleApplicationSession | ||
| Description |
Gets the | ||
| Return | osid.tracking.rules.QueueProcessorEnablerRuleApplicationSession | a QueueProcessorEnablerRuleApplicationSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQueueProcessorEnablerRuleApplication() is
false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerRuleApplication() is true. | |
| Method | getQueueProcessorEnablerRuleApplicationSessionForFrontOffice | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.tracking.rules.QueueProcessorEnablerRuleApplicationSession | a QueueProcessorEnablerRuleApplicationSession | |
| Errors | NOT_FOUND | no FrontOffice found by the given Id | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQueueProcessorEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsQueueProcessorEnablerRuleApplication() and
supportsVisibleFederation() are true. | |