OSID - osid.search.EngineNotificationSession Service Interface Definition

Interface	osid.search.EngineNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Engine` 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 `Engine` object itself. Adding and removing search result in notifications available from the notification session for search.
Method	canRegisterForEngineNotifications
Description	Tests if this user can register for `Engine` 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	reliableEngineNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeEngineNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableEngineNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeEngineNotification
Description	Acknowledge an engine 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	registerForNewEngines
Description	Register for notifications of new engines. `EngineReceiver.newEngine()` is invoked when a new `Engine` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEngines
Description	Registers for notification of updated engines. `EngineReceiver.changedEngine()` is invoked when an engine is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEngine
Description	Registers for notification of an updated engine. `EngineReceiver.changedEngine()` is invoked when the specified engine is changed.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine` to monitor
Errors	NOT_FOUND		an engine was not found identified by the given `Id`
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEngines
Description	Registers for notification of deleted engines. `EngineReceiver.deletedEngine()` is invoked when an engine is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEngine
Description	Registers for notification of a deleted engine. `EngineReceiver.deletedEngine()` is invoked when the specified engine is deleted.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine` to monitor
Errors	NOT_FOUND		an engine was not found identified by the given `Id`
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEngineHierarchy
Description	Registers for notification of an updated engine hierarchy structure. `EngineReceiver.changedChildOfEngines()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEngineHierarchyForAncestors
Description	Registers for notification of an updated engine hierarchy structure. `EngineReceiver.changedChildOfEngines()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine` node to monitor
Errors	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEngineHierarchyForDescendants
Description	Registers for notification of an updated engine hierarchy structure. `EngineReceiver.changedChildOfEngines()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine` node to monitor
Errors	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.