| Interface | osid.room.CampusNotificationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.room.RoomManager | ||
osid.room.RoomProxyManager | |||
| Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the
| ||
| Method | canRegisterForCampusNotifications | ||
| 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 | reliableCampusNotifications | ||
| Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using
| ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | unreliableCampusNotifications | ||
| Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | acknowledgeCampusNotification | ||
| Description |
Acknowledge a campus 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 | registerForNewCampuses | ||
| Description |
Register for notifications of new campuses.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedCampuses | ||
| Description |
Registers for notification of updated campuses.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedCampus | ||
| Description |
Registers for notification of an updated campus.
| ||
| Parameters | osid.id.Id | campusId | the Id of the Campus to monitor |
| Errors | NULL_ARGUMENT | campusId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedCampuses | ||
| Description |
Registers for notification of deleted campuses.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedCampus | ||
| Description |
Registers for notification of a deleted campus.
| ||
| Parameters | osid.id.Id | campusId | the Id of the Campus to monitor |
| Errors | NULL_ARGUMENT | campusId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedCampusHierarchy | ||
| Description |
Registers for notification of an updated campus
hierarchy structure.
| ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedCampusHierarchyForAncestors | ||
| Description |
Registers for notification of an updated campus
hierarchy structure.
| ||
| Parameters | osid.id.Id | campusId | the Id of the Campus node to monitor |
| Errors | NULL_ARGUMENT | campusId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedCampusHierarchyForDescendants | ||
| Description |
Registers for notification of an updated campus
hierarchy structure.
| ||
| Parameters | osid.id.Id | campusId | the Id of the Campus node to monitor |
| Errors | NULL_ARGUMENT | campusId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |