OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.CheckNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Check objects in this Engine. This also includes existing checks 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 CheckLookupSession.

MethodgetEngineId
Description

Gets the Engine Id associated with this session.

Returnosid.id.Idthe Engine Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetEngine
Description

Gets the Engine associated with this session.

Returnosid.rules.Enginethe engine
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForCheckNotifications
Description

Tests if this user can register for Check 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.
MethoduseFederatedEngineView
Description

Federates the view for methods in this session. A federated view will include checks in engines which are children of this engine in the engine hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedEngineView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this engine only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewChecks
Description

Register for notifications of new checks. CheckReceiver.newChecks() is invoked when a new Check appears in this engine.

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

Registers for notification of updated checks. CheckReceiver.changedChecks() is invoked when a check in this engine is changed.

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

Registers for notification of an updated hold. CheckReceiver.changedChecks() is invoked when the specified check in this engine is changed.

Parametersosid.id.IdcheckIdthe Id of the Check to monitor
ErrorsNOT_FOUNDa check was not found in this engine identified by the given Id
NULL_ARGUMENT checkId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedChecks
Description

Registers for notification of deleted checks. CheckReceiver.deletedChecks() is invoked when a check is deleted or removed from this engine.

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

Registers for notification of a deleted hold. CheckReceiver.deletedChecks() is invoked when the specified check is deleted or removed from this engine.

Parametersosid.id.IdcheckIdthe Id of the Check to monitor
ErrorsNOT_FOUNDa check was not found identified by the given Id
NULL_ARGUMENT checkId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.