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

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

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

Tests if this user can register for ActivityRegistration 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 activity 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.
MethodreliableActivityRegistrationNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableActivityRegistrationNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeActivityRegistrationNotification
Description

Acknowledge an activity registration notification.

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

Register for notifications of new activity registrations. ActivityRegistrationReceiver.newActivityRegistrations() is invoked when a new ActivityRegistration appears in this course catalog.

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

Register for notifications of new registrations for the given registration. ActivityRegistrationReceiver.newActivityRegistrations() is invoked when a new ActivityRegistration appears in 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.
MethodregisterForNewActivityRegistrationsForActivity
Description

Register for notifications of new registrations for the given activity. ActivityRegistrationReceiver.newActivityRegistrations() is invoked when a new ActivityRegistration appears in this course catalog.

Parametersosid.id.IdactivityIdthe Id of the Activity to monitor
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewActivityRegistrationsForStudent
Description

Register for notifications of new registrations for the given student. ActivityRegistrationnReceiver.newActivityRegistrations() is invoked when a new ActivityRegistration appears in this course catalog.

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

Registers for notification of updated activity registrations. ActivityRegistrationReceiver.changedActivityRegistrations() is invoked when a course in this course catalog is changed.

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

Registers for notification of updated activity registrations for the given registration. ActivityRegistrationReceiver.changedActivityRegistrations() is invoked when a course in this course catalog is changed.

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

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

Parametersosid.id.IdactivityIdthe Id of the Activity to monitor
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedActivityRegistrationsForStudent
Description

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

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

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

Parametersosid.id.IdactivityRegistrationIdthe Id of the ActivityRegistration to monitor
ErrorsNULL_ARGUMENT activityRegistrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedActivityRegistrations
Description

Registers for notification of deleted activity registrations. ActivityRegistrationReceiver.deletedActivityRegistrations() is invoked when an activity registration is deleted or removed from this course catalog.

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

Registers for notification of deleted activity registrations for the given registration. ActivityRegistrationReceiver.deletedActivityRegistrations() is invoked when an activity 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.
MethodregisterForDeletedActivityRegistrationsForActivity
Description

Registers for notification of deleted activity registrations for the given activity. ActivityRegistrationReceiver.deletedActivityRegistrations() is invoked when an activity registration is deleted or removed from this course catalog.

Parametersosid.id.IdactivityIdthe Id of the Activity to monitor
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedActivityRegistrationsForStudent
Description

Registers for notification of deleted activity registrations for the given student. ActivityRegistrationReceiver.deletedActivityRegistrations() is invoked when an activity registration is deleted or removed from this course catalog.

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

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

Parametersosid.id.IdactivityRegistrationIdthe Id of the ActivityRegistration to monitor
ErrorsNULL_ARGUMENT activityRegistrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.