OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.EnrollmentNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Enrollment objects in this CourseCatalog. This also includes existing enrollments that may appear or disappear due to changes in the CourseCatalog hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The views defined in this session correspond to the views in the EnrollmentLookupSession.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForEnrollmentNotifications
Description

Tests if this user can register for Enrollment notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCourseCatalogView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethodreliableEnrollmentNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeEnrollmentNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableEnrollmentNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeEnrollmentNotification
Description

Acknowledge an enrollment notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewEnrollments
Description

Register for notifications of new enrollments. EnrollmentReceiver.newEnrollments() is invoked when a new Enrollment appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewEnrollmentsForProgramOffering
Description

Register for notifications of new enrollments for the given program offering. EnrollmentReceiver.newEnrollments() is invoked when a new Enrollment appears in this course catalog.

Parametersosid.id.IdprogramOfferingIdthe Id of the ProgramOffering to monitor
ErrorsNULL_ARGUMENT programOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewEnrollmentsForStudent
Description

Register for notifications of new enrollments for the given student. EnrollmentReceiver.newEnrollments() is invoked when a new Enrollment appears in this course catalog.

Parametersosid.id.IdstudentIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT studentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEnrollments
Description

Registers for notification of updated enrollments. EnrollmentReceiver.changedEnrollments() is invoked when an enrollment in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEnrollmentsForProgramOffering
Description

Registers for notification of updated enrollments for the given program offering. EnrollmentReceiver.changedEnrollments() is invoked when an enrollment in this course catalog is changed.

Parametersosid.id.IdprogramOfferingIdthe Id of the ProgramOffering to monitor
ErrorsNULL_ARGUMENT programOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEnrollmentsForStudent
Description

Registers for notification of updated enrollments for the given student. EnrollmentReceiver.changedEnrollments() is invoked when a course in this course catalog is changed.

Parametersosid.id.IdstudentIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT studentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEnrollment
Description

Registers for notification of an updated enrollment. EnrollmentReceiver.changedEnrollments() is invoked when the specified enrollment in this course catalog is changed.

Parametersosid.id.IdenrollmentIdthe Id of the Enrollment to monitor
ErrorsNULL_ARGUMENT enrollmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEnrollments
Description

Registers for notification of deleted enrollments. EnrollmentReceiver.deletedEnrollments() is invoked when an enrollment is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEnrollmentsForProgramOffering
Description

Registers for notification of deleted enrollments for the given program offering. EnrollmentReceiver.deletedEnrollments() is invoked when an enrollment is deleted or removed from this course catalog.

Parametersosid.id.IdprogramOfferingIdthe Id of the ProgramOffering to monitor
ErrorsNULL_ARGUMENT programOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEnrollmentsForStudent
Description

Registers for notification of deleted enrollments for the given student. EnrollmentReceiver.deletedEnrollments() is invoked when an enrollment is deleted or removed from this course catalog.

Parametersosid.id.IdstudentIdthe Id of the Resource to monitor
ErrorsNULL_ARGUMENT studentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEnrollment
Description

Registers for notification of a deleted enrollment. EnrollmentReceiver.deletedEnrollments() is invoked when the specified enrollment is deleted or removed from this course catalog.

Parametersosid.id.IdenrollmentIdthe Id of the Enrollment to monitor
ErrorsNULL_ARGUMENT enrollmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.