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

Interface	osid.course.chronicle.AwardEntryNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `AwardEntry` 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 `AwardEntryLookupSession.`
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	canRegisterForAwardEntryNotifications
Description	Tests if this user can register for `AwardEntry` 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 award 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	reliableAwardEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAwardEntryNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAwardEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAwardEntryNotification
Description	Acknowledge an award 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	registerForNewAwardEntries
Description	Register for notifications of new award entries. `AwardEntryReceiver.newAwardEntries()` is invoked when a new `AwardEntry` 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	registerForNewAwardEntriesForStudent
Description	Registers for notification of new award entries for the given student. `AwardEntryReceiver.newAwardEntries()` is invoked when a new award 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	registerForNewAwardEntriesForAward
Description	Registers for notification of new award entries for the given award. `AwardEntryReceiver.newAwardEntries()` is invoked when a new award entry appears in this course catalog.
Parameters	`osid.id.Id`	`awardId`	the `Id` of the `Award` to monitor
Errors	NULL_ARGUMENT		`awardId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAwardEntries
Description	Registers for notification of updated award entries. `AwardEntryReceiver.changedAwardEntries()` is invoked when an award 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	registerForChangedAwardEntriesForStudent
Description	Registers for notification of updated award entries for the given student. `AwardEntryReceiver.changedAwardEntries()` is invoked when an award entry is changed 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	registerForChangedAwardEntriesForAward
Description	Registers for notification of updated award entries for the given award. `AwardEntryReceiver.changedAwardEntries()` is invoked when an award entry is changed in this course catalog.
Parameters	`osid.id.Id`	`awardId`	the `Id` of the `Award` to monitor
Errors	NULL_ARGUMENT		`awardId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAwardEntry
Description	Registers for notification of an updated award entry. `AwardEntryReceiver.changedAwardEntries()` is invoked when the specified award entry in this course catalog is changed.
Parameters	`osid.id.Id`	`awardEntryId`	the `Id` of the `AwardEntry` to monitor
Errors	NULL_ARGUMENT		`awardEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAwardEntries
Description	Registers for notification of deleted award entries. `AwardEntryReceiver.deletedAwardEntries()` is invoked when an award 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	registerForDeletedAwardEntriesForStudent
Description	Registers for notification of deleted award entries for the given student. `AwardEntryReceiver.changedAwardEntries()` is invoked when an award entry is deleted or 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	registerForDeletedAwardEntriesForAward
Description	Registers for notification of deleted award entries for the given award. `AwardEntryReceiver.changedAwardEntries()` is invoked when an award entry is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`awardId`	the `Id` of the `Award` to monitor
Errors	NULL_ARGUMENT		`awardId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAwardEntry
Description	Registers for notification of a deleted award entry. `AwardEntryReceiver.deletedAwardEntries()` is invoked when the specified award entry is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`awardEntryId`	the `Id` of the `AwardEntry` to monitor
Errors	NULL_ARGUMENT		`awardEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.