OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Registration objects in this CourseCatalog. This also includes existing registrations 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 RegistrationLookupSession.

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.
MethodcanRegisterForRegistrationNotifications
Description

Tests if this user can register for Registration 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 registrations 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.
MethodreliableRegistrationNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableRegistrationNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeRegistrationNotification
Description

Acknowledge a registration notification.

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

Register for notifications of new registrations. RegistrationReceiver.newRegistrations() is invoked when a new Registration appears in this course catalog.

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

Register for notifications of new registrations for the given activity bundle. RegistrationReceiver.newRegistrations() is invoked when a new Registration appears in this course catalog.

Parametersosid.id.IdactivityBundleIdthe Id of the ActivityBundle to monitor
ErrorsNULL_ARGUMENT activityBundleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRegistrationsForCourseOffering
Description

Register for notifications of new registrations for the given course offering. RegistrationReceiver.newRegistrations() is invoked when a new Registration appears in this course catalog.

Parametersosid.id.IdcourseOfferingIdthe Id of the CourseOffering to monitor
ErrorsNULL_ARGUMENT courseOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRegistrationsForStudent
Description

Register for notifications of new registrations for the given sudent resource. RegistrationReceiver.newRegistrations() is invoked when a new Registration appears in this course catalog.

Parametersosid.id.IdresourceIdthe Id of the student to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRegistrations
Description

Registers for notification of updated registrations. RegistrationReceiver.changedRegistrations() is invoked when a course in this course catalog is changed.

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

Registers for notification of updated registrations for the given activity bundle. RegistrationReceiver.changedRegistrations() is invoked when a course in this course catalog is changed.

Parametersosid.id.IdactivityBundleIdthe Id of the ActivityBundle to monitor
ErrorsNULL_ARGUMENT activityBundleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRegistrationsForCourseOffering
Description

Registers for notification of updated registrations for the given course offering. RegistrationReceiver.changedRegistrations() is invoked when a course in this course catalog is changed.

Parametersosid.id.IdcourseOfferingIdthe Id of the CourseOffering to monitor
ErrorsNULL_ARGUMENT courseOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRegistrationsForStudent
Description

Registers for notification of updated registrations for the given student. RegistrationReceiver.changedRegistrations() is invoked when a course in this course catalog is changed.

Parametersosid.id.IdresourceIdthe Id of the student to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRegistration
Description

Registers for notification of an updated registration. RegistrationReceiver.changedRegistrations() is invoked when the specified registration in this course catalog is changed.

Parametersosid.id.IdregistrationIdthe Id of the Registration to monitor
ErrorsNULL_ARGUMENT registrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRegistrations
Description

Registers for notification of deleted registrations. RegistrationReceiver.deletedRegistrations() is invoked when a registration is deleted or removed from this course catalog.

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

Registers for notification of deleted registrations for the given activity bundle. RegistrationReceiver.deletedRegistrations() is invoked when a registration is deleted or removed from this course catalog.

Parametersosid.id.IdactivityBundleIdthe Id of the ActivityBundle to monitor
ErrorsNULL_ARGUMENT activityBundleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRegistrationsForCourseOffering
Description

Registers for notification of deleted registrations for the given course offering. RegistrationReceiver.deletedRegistrations() is invoked when a registration is deleted or removed from this course catalog.

Parametersosid.id.IdcourseOfferingIdthe Id of the CourseOffering to monitor
ErrorsNULL_ARGUMENT courseOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRegistrationsForStudent
Description

Registers for notification of deleted registrations for the given student. RegistrationReceiver.deletedRegistrations() is invoked when a registration is deleted or removed from this course catalog.

Parametersosid.id.IdresourceIdthe Id of the student to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRegistration
Description

Registers for notification of a deleted registration. RegistrationReceiver.deletedRegistrations() is invoked when the specified registration is deleted or removed from this course catalog.

Parametersosid.id.IdregistrationIdthe Id of the Registration to monitor
ErrorsNULL_ARGUMENT registrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.