OSID - osid.rules.check.AgendaNotificationSession Service Interface Definition

Interface	osid.rules.check.AgendaNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Agenda` objects in this `Engine`. This also includes existing agendas that may appear or disappear due to changes in the `Engine` 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 `AgendaLookupSession`.
Method	getEngineId
Description	Gets the `Engine` `Id` associated with this session.
Return	`osid.id.Id`		the `Engine Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getEngine
Description	Gets the `Engine` associated with this session.
Return	`osid.rules.Engine`		the engine
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAgendaNotifications
Description	Tests if this user can register for `Agenda` 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	useFederatedEngineView
Description	Federates the view for methods in this session. A federated view will include agendas in engines which are children of this engine in the engine hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedEngineView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this engine only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableAgendaNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAgendaNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAgendaNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAgendaNotification
Description	Acknowledge an agenda 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	registerForNewAgendas
Description	Register for notifications of new agendas. `AgendaReceiver.newAgendas()` is invoked when a new `Agenda` appears in this engine.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAgendas
Description	Registers for notification of updated agendas. `AgendaReceiver.changedAgendas()` is invoked when an agenda in this engine is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAgenda
Description	Registers for notification of an updated agenda. `AgendaReceiver.changedAgendas()` is invoked when the specified agenda in this engine is changed.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda` to monitor
Errors	NOT_FOUND		an agenda was not found in this engine identified by the given `Id`
	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAgendas
Description	Registers for notification of deleted agendas. `AgendaReceiver.deletedAgendas()` is invoked when an agenda is deleted or removed from this engine.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAgenda
Description	Registers for notification of a deleted agenda. `AgendaReceiver.deletedAgendas()` is invoked when the specified agenda is deleted or removed from this engine.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda` to monitor
Errors	NOT_FOUND		an agenda was not found identified by the given `Id`
	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.