OSID - osid.recognition.ConferralNotificationSession Service Interface Definition

Interface	osid.recognition.ConferralNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.recognition.RecognitionManager`
Used By	`osid.recognition.RecognitionProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Conferrals`. 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	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	canRegisterForConferralNotifications
Description	Tests if this user can register for `Conferral` 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 conferrals 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	reliableConferralNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeConferralNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableConferralNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeConferralNotification
Description	Acknowledge a conferral 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	registerForNewConferrals
Description	Register for notifications of new conferrals. `ConferralReceiver.newConferrals()` is invoked when a new `Conferral` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewConferralsForRecipient
Description	Register for notifications of new conferrals for the given recipient `Id`. `ConferralReceiver.newConferrals()` is invoked when a new `Conferral` is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the recipient 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	registerForNewConferralsForAward
Description	Register for notifications of new conferrals for the given reference `Id`. `ConferralReceiver.newConferrals()` is invoked when a new `Conferral` is created.
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	registerForNewConferralsByConvocation
Description	Register for notifications of new conferrals for the given convocation `Id`. `ConferralReceiver.newConferrals()` is invoked when a new `Conferral` is created.
Parameters	`osid.id.Id`	`convocationId`	the `Id` of the convocation to monitor
Errors	NULL_ARGUMENT		`convocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConferrals
Description	Registers for notification of updated conferrals. `ConferralReceiver.changedConferrals()` is invoked when a conferral is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConferralsForRecipient
Description	Register for notifications of changed conferrals for the given recipient `Id`. `ConferralReceiver.changedConferrals()` is invoked when a `Conferral` for the recipient 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	registerForChangedConferralsForAward
Description	Register for notifications of changed conferrals for the given award `Id`. `ConferralReceiver.changedConferrals()` is invoked when a `Conferral` for the 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	registerForChangedConferralsByConvocation
Description	Register for notifications of changed conferrals for the given award `Id`. `ConferralReceiver.changedConferrals()` is invoked when a `Conferral` for the convocation is changed.
Parameters	`osid.id.Id`	`convocationId`	the `Id` of the convocation to monitor
Errors	NULL_ARGUMENT		`convocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConferral
Description	Registers for notification of an updated conferral. `ConferralReceiver.changedConferrals()` is invoked when the specified conferral is changed.
Parameters	`osid.id.Id`	`conferralId`	the `Id` of the `Conferral` to monitor
Errors	NULL_ARGUMENT		`conferralId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedConferrals
Description	Registers for notification of deleted conferrals. `ConferralReceiver.deletedConferrals()` is invoked when a conferral is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedConferralsForRecipient
Description	Register for notifications of deleted conferrals for the given recipient `Id`. `ConferralReceiver.deletedConferrals()` is invoked when a `Conferral` for the recipient is deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the recipient to monitor
Errors	NULL_ARGUMENT		`recipientId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedConferralsForAward
Description	Register for notifications of deleted conferrals for the given award `Id`. `ConferralReceiver.deletedConferrals()` is invoked when a `Conferral` for the 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.
Method	registerForDeletedConferralsByConvocation
Description	Register for notifications of deleted conferrals for the given convocation `Id`. `ConferralReceiver.deletedConferrals()` is invoked when a `Conferral` for the convocation is deleted.
Parameters	`osid.id.Id`	`convocationId`	the `Id` of the convocation to monitor
Errors	NULL_ARGUMENT		`convocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedConferral
Description	Registers for notification of a deleted conferral. `ConferralReceiver.deletedConferrals()` is invoked when the specified conferral is deleted.
Parameters	`osid.id.Id`	`conferralId`	the `Id` of the `Conferral` to monitor
Errors	NULL_ARGUMENT		`conferralId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.