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

Interface	osid.course.syllabus.SyllabusNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Syllabus` 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.
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	canRegisterForSyllabusNotifications
Description	Tests if this user can register for `Syllabus` 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 syllabi 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	reliableSyllabusNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeSyllabusNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableSyllabusNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeSyllabusNotification
Description	Acknowledge a syllabus 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	registerForNewSyllabi
Description	Register for notifications of new syllabi. `SyllabusReceiver.newSyllabi()` is invoked when a new `Syllabus` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewSyllabiForCourse
Description	Register for notifications of new syllabi for the given course `.` `SyllabusReceiver.newSyllabi()` is invoked when a new `Syllabus` is created.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the course to monitor
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSyllabi
Description	Registers for notification of updated syllabi. `SyllabusReceiver.changedSyllabi()` is invoked when a syllabus is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSyllabiForCourse
Description	Register for notifications of changed syllabi for the given course `Id.` `SyllabusReceiver.changedSyllabi()` is invoked when a `Syllabus` for the coursein this catalog is changed.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the course to monitor
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSyllabus
Description	Registers for notification of an updated syllabus. `SyllabusReceiver.changedSyllabi()` is invoked when the specified syllabus 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	registerForDeletedSyllabi
Description	Registers for notification of deleted syllabi. `SyllabusReceiver.deletedSyllabi()` is invoked when a syllabus is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSyllabiForCourse
Description	Register for notifications of deleted syllabi for the given course `Id.` `SyllabusReceiver.deletedSyllabi()` is invoked when a `Syllabus` for the course in this catalog is deleted.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the course to monitor
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSyllabus
Description	Registers for notification of a deleted syllabus. `SyllabusReceiver.deletedSyllabi()` is invoked when the specified syllabus 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.