OSID - osid.recognition.ConvocationNotificationSession Service Interface Definition

Interface	osid.recognition.ConvocationNotificationSession
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 `Convocations`. 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	canRegisterForConvocationNotifications
Description	Tests if this user can register for `Convocation` 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 convocations 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	reliableConvocationNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeConvocationNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableConvocationNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeConvocationNotification
Description	Acknowledge a convocation 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	registerForNewConvocations
Description	Register for notifications of new convocations. `ConvocationReceiver.newConvocations()` is invoked when a new `Convocation` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConvocations
Description	Registers for notification of updated convocations. `ConvocationReceiver.changedConvocations()` is invoked when a convocation is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConvocation
Description	Registers for notification of an updated convocation. `ConvocationReceiver.changedConvocations()` is invoked when the specified 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	registerForDeletedConvocations
Description	Registers for notification of deleted convocations. `ConvocationReceiver.deletedConvocations()` is invoked when a convocation is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedConvocation
Description	Registers for notification of a deleted convocation. `ConvocationReceiver.deletedConvocations()` is invoked when the specified 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.