| Interface | osid.tracking.FrontOfficeNotificationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.tracking.TrackingManager | ||
osid.tracking.TrackingProxyManager | |||
| Description |
This session defines methods to receive notifications on
adds/changes to | ||
| Method | canRegisterForFrontOfficeNotifications | ||
| 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 | reliableFrontOfficeNotifications | ||
| Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using
| ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | unreliableFrontOfficeNotifications | ||
| Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | acknowledgeFrontOfficeNotification | ||
| Description |
Acknowledge a front office notification. | ||
| Parameters | osid.id.Id | notificationId | the Id of the notification |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForNewFrontOffices | ||
| Description |
Register for notifications of new frontOffices.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedFrontOffices | ||
| Description |
Registers for notification of updated frontOffices.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedFrontOffice | ||
| Description |
Registers for notification of an updated front office.
| ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice to monitor |
| Errors | NULL_ARGUMENT | frontOfficeId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedFrontOffices | ||
| Description |
Registers for notification of deleted frontOffices.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedFrontOffice | ||
| Description |
Registers for notification of a deleted front office.
| ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice to monitor |
| Errors | NULL_ARGUMENT | frontOfficeId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedFrontOfficeHierarchy | ||
| Description |
Registers for notification of an updated front office
hierarchy structure.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedFrontOfficeHierarchyForAncestors | ||
| Description |
Registers for notification of an updated front office
hierarchy structure.
| ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice node to monitor |
| Errors | NULL_ARGUMENT | frontOfficeId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedFrontOfficeHierarchyForDescendants | ||
| Description |
Registers for notification of an updated front office
hierarchy structure.
| ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice node to monitor |
| Errors | NULL_ARGUMENT | frontOfficeId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |