Interface | osid.tracking.rules.QueueConstrainerEnablerNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getFrontOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the FrontOffice Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOffice | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOffice | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForQueueConstrainerEnablerNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedFrontOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include enablers in front offices which are children of this front office in the front office hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedFrontOfficeView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this front office only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewQueueConstrainerEnablers | ||
Description |
Register for notifications of new queue constrainer
enablers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedQueueConstrainerEnablers | ||
Description |
Registers for notification of updated front office
enabelrs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedQueueConstrainerEnabler | ||
Description |
Registers for notification of an updated queue
constrainer enabler. | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | the Id of the QueueConstrainerEnabler to
monitor |
Errors | NOT_FOUND | a queue constrainer enabler was not found in this queue matchmaker
identified by the given Id | |
NULL_ARGUMENT | queueConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedQueueConstrainerEnablers | ||
Description |
Registers for notification of deleted queue constrainer
enablers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedQueueConstrainerEnabler | ||
Description |
Registers for notification of a deleted queue
constrainer enabler. | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | the Id of the QueueConstrainerEnabler to
monitor |
Errors | NOT_FOUND | a queue constrainer enabler was not found in this queue matchmaker
identified by the given Id | |
NULL_ARGUMENT | queueConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |