| Interface | osid.room.CampusNotificationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| 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 | 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 | registerForNewCampusAncestors | ||
| Description |
Registers for notification of an updated hierarchy
structure that introduces a new ancestor of the specified
campus. | ||
| 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 | registerForNewCampusDescendants | ||
| Description |
Registers for notification of an updated hierarchy
structure that introduces a new descendant of the
specified campus. | ||
| 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 | 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 | registerForDeletedCampusAncestors | ||
| Description |
Registers for notification of an updated hierarchy
structure that removes an ancestor of the specified 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 | registerForDeletedCampusDescendants | ||
| Description |
Registers for notification of an updated hierarchy
structure that removes a descendant of the specified
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. | |