Interface | osid.course.program.EnrollmentNotificationSession | ||
---|---|---|---|
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 | canRegisterForEnrollmentNotifications | ||
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 enrollments 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 | reliableEnrollmentNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableEnrollmentNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeEnrollmentNotification | ||
Description |
Acknowledge an enrollment 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 | registerForNewEnrollments | ||
Description |
Register for notifications of new enrollments. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewEnrollmentsForProgramOffering | ||
Description |
Register for notifications of new enrollments for the
given program offering. | ||
Parameters | osid.id.Id | programOfferingId | the Id of the ProgramOffering to monitor |
Errors | NULL_ARGUMENT | programOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewEnrollmentsForStudent | ||
Description |
Register for notifications of new enrollments for the
given student. | ||
Parameters | osid.id.Id | studentId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | studentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedEnrollments | ||
Description |
Registers for notification of updated enrollments.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedEnrollmentsForProgramOffering | ||
Description |
Registers for notification of updated enrollments for
the given program offering. | ||
Parameters | osid.id.Id | programOfferingId | the Id of the ProgramOffering to monitor |
Errors | NULL_ARGUMENT | programOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedEnrollmentsForStudent | ||
Description |
Registers for notification of updated enrollments for
the given student. | ||
Parameters | osid.id.Id | studentId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | studentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedEnrollment | ||
Description |
Registers for notification of an updated enrollment.
| ||
Parameters | osid.id.Id | enrollmentId | the Id of the Enrollment to monitor |
Errors | NULL_ARGUMENT | enrollmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedEnrollments | ||
Description |
Registers for notification of deleted enrollments.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedEnrollmentsForProgramOffering | ||
Description |
Registers for notification of deleted enrollments for
the given program offering. | ||
Parameters | osid.id.Id | programOfferingId | the Id of the ProgramOffering to monitor |
Errors | NULL_ARGUMENT | programOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedEnrollmentsForStudent | ||
Description |
Registers for notification of deleted enrollments for
the given student. | ||
Parameters | osid.id.Id | studentId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | studentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedEnrollment | ||
Description |
Registers for notification of a deleted enrollment.
| ||
Parameters | osid.id.Id | enrollmentId | the Id of the Enrollment to monitor |
Errors | NULL_ARGUMENT | enrollmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |