Interface | osid.course.registration.RegistrationNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The views defined in this session correspond to the views
in the | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForRegistrationNotifications | ||
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 | useFederatedCourseCatalogView | ||
Description |
Federates the view for methods in this session. A federated view will include registrations in catalogs which are children of this catalog in the course catalog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCourseCatalogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this course catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableRegistrationNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableRegistrationNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeRegistrationNotification | ||
Description |
Acknowledge a registration 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 | registerForNewRegistrations | ||
Description |
Register for notifications of new registrations. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRegistrationsForActivityBundle | ||
Description |
Register for notifications of new registrations for the
given activity bundle. | ||
Parameters | osid.id.Id | activityBundleId | the Id of the ActivityBundle to monitor |
Errors | NULL_ARGUMENT | activityBundleId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRegistrationsForCourseOffering | ||
Description |
Register for notifications of new registrations for the
given course offering. | ||
Parameters | osid.id.Id | courseOfferingId | the Id of the CourseOffering to monitor |
Errors | NULL_ARGUMENT | courseOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRegistrationsForStudent | ||
Description |
Register for notifications of new registrations for the
given sudent resource. | ||
Parameters | osid.id.Id | resourceId | the Id of the student to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRegistrations | ||
Description |
Registers for notification of updated registrations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRegistrationsForActivityBundle | ||
Description |
Registers for notification of updated registrations for
the given activity bundle. | ||
Parameters | osid.id.Id | activityBundleId | the Id of the ActivityBundle to monitor |
Errors | NULL_ARGUMENT | activityBundleId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRegistrationsForCourseOffering | ||
Description |
Registers for notification of updated registrations for
the given course offering. | ||
Parameters | osid.id.Id | courseOfferingId | the Id of the CourseOffering to monitor |
Errors | NULL_ARGUMENT | courseOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRegistrationsForStudent | ||
Description |
Registers for notification of updated registrations for
the given student. | ||
Parameters | osid.id.Id | resourceId | the Id of the student to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRegistration | ||
Description |
Registers for notification of an updated registration.
| ||
Parameters | osid.id.Id | registrationId | the Id of the Registration to monitor |
Errors | NULL_ARGUMENT | registrationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRegistrations | ||
Description |
Registers for notification of deleted registrations.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRegistrationsForActivityBundle | ||
Description |
Registers for notification of deleted registrations for
the given activity bundle. | ||
Parameters | osid.id.Id | activityBundleId | the Id of the ActivityBundle to monitor |
Errors | NULL_ARGUMENT | activityBundleId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRegistrationsForCourseOffering | ||
Description |
Registers for notification of deleted registrations for
the given course offering. | ||
Parameters | osid.id.Id | courseOfferingId | the Id of the CourseOffering to monitor |
Errors | NULL_ARGUMENT | courseOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRegistrationsForStudent | ||
Description |
Registers for notification of deleted registrations for
the given student. | ||
Parameters | osid.id.Id | resourceId | the Id of the student to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRegistration | ||
Description |
Registers for notification of a deleted registration.
| ||
Parameters | osid.id.Id | registrationId | the Id of the Registration to monitor |
Errors | NULL_ARGUMENT | registrationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |