OSID - osid.course.syllabus.ModuleNotificationSession Service Interface Definition

Interface	osid.course.syllabus.ModuleNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.course.syllabus.CourseSyllabusManager`
Used By	`osid.course.syllabus.CourseSyllabusProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Modules`. 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.
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForModuleNotifications
Description	Tests if this user can register for `Module` 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.
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 modules in course catalogs which are children of this course 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 retrievals to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableModuleNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeModuleNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableModuleNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeModuleNotification
Description	Acknowledge a module notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewModules
Description	Register for notifications of new modules. `ModuleReceiver.newModules()` is invoked when a new `Module` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewModulesForSyllabus
Description	Register for notifications of new modules for the given syllabus. `ModuleReceiver.newModules()` is invoked when a new `Module` is created.
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of the `Syllabus` to monitor
Errors	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedModules
Description	Registers for notification of updated modules. `ModuleReceiver.changedModules()` is invoked when a module is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedModulesForSyllabus
Description	Registers for notification of updated modules for the given syllabus. `ModuleReceiver.changedModules()` is invoked when a module is changed.
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of the `Syllabus` to monitor
Errors	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedModule
Description	Registers for notification of an updated module. `ModuleReceiver.changedModules()` is invoked when the specified module is changed.
Parameters	`osid.id.Id`	`moduleId`	the `Id` of the `Module` to monitor
Errors	NULL_ARGUMENT		`moduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedModules
Description	Registers for notification of deleted modules. `ModuleReceiver.deletedModules()` is invoked when a module in this catalog is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedModulesForSyllabus
Description	Registers for notification of deleted modules for the given syllabus. `ModuleReceiver.deletedModules()` is invoked when a module in this catalog is deleted.
Parameters	`osid.id.Id`	`syllabusId`	the `Id` of the `Syllabus` to monitor
Errors	NULL_ARGUMENT		`syllabusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedModule
Description	Registers for notification of a deleted module. `ModuleReceiver.deletedModules()` is invoked when the specified module in this catalog is deleted.
Parameters	`osid.id.Id`	`moduleId`	the `Id` of the `Module` to monitor
Errors	NULL_ARGUMENT		`moduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.