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

Interface	osid.course.syllabus.DocetNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Docet` 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 session is closed. Notifications are triggered with changes to the `Docet` object itself. Adding and removing syllabi result in notifications available from the notification session for syllabi.
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	canRegisterForDocetNotifications
Description	Tests if this user can register for `Docet` 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 docetsin 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	reliableDocetNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeDocetNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableDocetNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeDocetNotification
Description	Acknowledge a docet 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	registerForNewDocets
Description	Register for notifications of new docets. `DocetReceiver.newDocets()` is invoked when a new `Docet` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewDocetsForModule
Description	Registers for notification of new docets of the given module. `DocetReceiver.newDocets()` is invoked when a new `Docet` is created.
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	registerForNewDocetsForActivityUnit
Description	Registers for notification of new docets of the given activity unit. `DocetReceiver.newDocets()` is invoked when a new `Docet` is created.
Parameters	`osid.id.Id`	`activityUnitId`	the `Id` of the `ActivityUnit` to monitor
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDocets
Description	Registers for notification of updated docets. `DocetReceiver.changedDocets()` is invoked when a docet is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDocetsForModule
Description	Registers for notification of updated docets of the given module. `DocetReceiver.changedDocets()` is invoked when a a docet 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	registerForChangedDocetsForActivityUnit
Description	Registers for notification of updated docets of the given activity unit. `DocetReceiver.changedDocets()` is invoked when a a docet is changed.
Parameters	`osid.id.Id`	`activityUnitId`	the `Id` of the `ActivityUnit` to monitor
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDocet
Description	Registers for notification of an updated docet. `DocetReceiver.changedDocet()` is invoked when the specified docet in this course catalog is changed.
Parameters	`osid.id.Id`	`docetId`	the `Id` of the `Docet` to monitor
Errors	NULL_ARGUMENT		`docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDocets
Description	Registers for notification of deleted docets. `DocetReceiver.deletedDocets()` is invoked when a docet is in this course catalog deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDocetsForModule
Description	Registers for notification of deleted docets of the given module. `DocetReceiver.deletedDocets()` is invoked when a docet in this course catalog is removed.
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	registerForDeletedDocetsForActivityUnit
Description	Registers for notification of deleted docets of the given activity unit. `DocetReceiver.deletedDocets()` is invoked when a docet in this course catalog is removed.
Parameters	`osid.id.Id`	`activityUnitId`	the `Id` of the `ActivityUnit` to monitor
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDocet
Description	Registers for notification of a deleted docet. `DocetReceiver.deletedDocets()` is invoked when the specified docet is deleted.
Parameters	`osid.id.Id`	`docetId`	the `Id` of the `Docet` to monitor
Errors	NULL_ARGUMENT		`docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.