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

This session defines methods to receive notifications on adds/changes to CourseCatalog objects. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this sess

MethodcanRegisterForCourseCatalogNotifications
Description

Tests if this user can register for CourseCatalog 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.
MethodreliableCourseCatalogNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableCourseCatalogNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCourseCatalogNotification
Description

Acknowledge a course catalog notification.

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

Register for notifications of new course catalogs. CourseCatalogReceiver.newCourseCatalogs() is invoked when a new CourseCatalog is created.

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

Registers for notification of updated course catalogs. CourseCatalogReceiver.changedCourseCatalogs() is invoked when a course catalog is changed.

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

Registers for notification of an updated course catalog. CourseCatalogReceiver.changedCourseCatalogs() is invoked when the specified course catalog is changed.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog to monitor
ErrorsNULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseCatalogs
Description

Registers for notification of deleted course catalogs. CourseCatalogReceiver.deletedCourseCatalogs() is invoked when a course catalog is deleted.

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

Registers for notification of a deleted course catalog. CourseCatalogReceiver.deletedCourseCatalogs() is invoked when the specified course catalog is deleted.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog to monitor
ErrorsNULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseCatalogHierarchy
Description

Registers for notification of an updated course catalog hierarchy structure. CourseCataloReceiver.changedChildOfCourseCatalos() is invoked when a node experiences a change in its children.

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

Registers for notification of an updated course catalog hierarchy structure. CourseCataloReceiver.changedChildOfCourseCatalos() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalo node to monitor
ErrorsNULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseCatalogHierarchyForDescendants
Description

Registers for notification of an updated course catalog hierarchy structure. CourseCatalogReceiver.changedChildOfCourseCatalos() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalo node to monitor
ErrorsNULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.