OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.EngineNotificationSession
Implementsosid.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.

MethodcanRegisterForEngineNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableEngineNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeEngineNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableEngineNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeEngineNotification
Description

Acknowledge an engine notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewEngines
Description

Register for notifications of new engines. EngineReceiver.newEngine() is invoked when a new Engine is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEngines
Description

Registers for notification of updated engines. EngineReceiver.changedEngine() is invoked when an engine is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEngine
Description

Registers for notification of an updated engine. EngineReceiver.changedEngine() is invoked when the specified engine is changed.

Parametersosid.id.IdengineIdthe Id of the Engine to monitor
ErrorsNOT_FOUNDan engine was not found identified by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEngines
Description

Registers for notification of deleted engines. EngineReceiver.deletedEngine() is invoked when an engine is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedEngine
Description

Registers for notification of a deleted engine. EngineReceiver.deletedEngine() is invoked when the specified engine is deleted.

Parametersosid.id.IdengineIdthe Id of the Engine to monitor
ErrorsNOT_FOUNDan engine was not found identified by the given Id
NULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEngineHierarchy
Description

Registers for notification of an updated engine hierarchy structure. EngineReceiver.changedChildOfEngines() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEngineHierarchyForAncestors
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.

Parametersosid.id.IdengineIdthe Id of the Engine node to monitor
ErrorsNULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedEngineHierarchyForDescendants
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.

Parametersosid.id.IdengineIdthe Id of the Engine node to monitor
ErrorsNULL_ARGUMENT engineId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.