OSID - osid.recognition.AwardNotificationSession Service Interface Definition

Interface	osid.recognition.AwardNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Award` 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 `Award` object itself. Adding and removing conferrals result in notifications available from the notification session for conferrals.
Method	getAcademyId
Description	Gets the `Academy` `Id` associated with this session.
Return	`osid.id.Id`		the `Academy Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAcademy
Description	Gets the `Academy` associated with this session.
Return	`osid.recognition.Academy`		the academy
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAwardNotifications
Description	Tests if this user can register for `Award` 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	useFederatedAcademyView
Description	Federates the view for methods in this session. A federated view will include awards in academies which are children of this academy in the academy hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAcademyView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.
Compliance	`mandatory`		This method is must be implemented.
Method	registerForNewAwards
Description	Register for notifications of new awards. `AwardReceiver.newAwards()` is invoked when a new `Award` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAwards
Description	Registers for notification of updated awards. `AwardReceiver.changedAwards()` is invoked when an award is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAward
Description	Registers for notification of an updated award. `AwardReceiver.changedAwards()` is invoked when the specified award is changed.
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	registerForDeletedAwards
Description	Registers for notification of deleted awards. `AwardReceiver.deletedAwards()` is invoked when an award is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAward
Description	Registers for notification of a deleted award. `AwardReceiver.deletedAwards()` is invoked when the specified award is deleted.
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.