OSID - osid.course.chronicle.ProgramEntryNotificationSession Service Interface Definition

Interface	osid.course.chronicle.ProgramEntryNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `ProgramEntry` objects in this `CourseCatalog`. This also includes existing courses 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 two views defined in this session correspond to the views in the `ProgramEntryLookupSession`.
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	canRegisterForProgramEntryNotifications
Description	Tests if this user can register for `ProgramEntry` 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 program entries in catalogs which are children of this 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 notifications to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableProgramEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeProgramEntryNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableProgramEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeProgramEntryNotification
Description	Acknowledge a program entry 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	registerForNewProgramEntries
Description	Register for notifications of new program entries. `ProgramEntryReceiver.newProgramEntries()` is invoked when a new `ProgramEntry` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProgramEntriesForStudent
Description	Registers for notification of new program entries for the given student. `ProgramEntryReceiver.newProgramEntries()` is invoked when a new program entry appears in this course catalog.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProgramEntriesForProgram
Description	Registers for notification of new program entries for the given program. `ProgramEntryReceiver.newProgramEntries()` is invoked when a new program entry appears in this course catalog.
Parameters	`osid.id.Id`	`programId`	the `Id` of the `Program` to monitor
Errors	NULL_ARGUMENT		`programId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProgramEntries
Description	Registers for notification of updated program entries. `ProgramEntryReceiver.changedProgramEntries()` is invoked when a program entry in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProgramEntriesForStudent
Description	Registers for notification of updated program entries for the given student. `ProgramEntryReceiver.changedProgramEntries()` is invoked when a program entry in this course catalog is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProgramEntriesForProgram
Description	Registers for notification of updated program entries for the given program. `ProgramEntryReceiver.changedProgramEntries()` is invoked when a program entry in this course catalog is changed.
Parameters	`osid.id.Id`	`programId`	the `Id` of the `Program` to monitor
Errors	NULL_ARGUMENT		`programId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProgramEntry
Description	Registers for notification of an updated program entry. `ProgramEntryReceiver.changedProgramEntries()` is invoked when the specified program entry in this course catalog is changed.
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry` to monitor
Errors	NULL_ARGUMENT		`programEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProgramEntries
Description	Registers for notification of deleted program entries. `ProgramEntryReceiver.deletedProgramEntries()` is invoked when a program entry is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProgramEntriesForStudent
Description	Registers for notification of deleted program entries for the given student. `ProgramEntryReceiver.deletedProgramEntries()` is invoked when a program entry is removed from this course catalog.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProgramEntriesForProgram
Description	Registers for notification of deleted program entries for the given program. `ProgramEntryReceiver.deletedProgramEntries()` is invoked when a program entry is removed from this course catalog.
Parameters	`osid.id.Id`	`programId`	the `Id` of the `Program` to monitor
Errors	NULL_ARGUMENT		`programId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProgramEntry
Description	Registers for notification of a deleted program entry. `ProgramEntryReceiver.deletedProgramEntries()` is invoked when the specified program entry is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry` to monitor
Errors	NULL_ARGUMENT		`programEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.