OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.TriggerNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Trigger objects in this System. This also includes existing triggers that may appear or disappear due to changes in the System 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 TriggerLookupSession.

MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForTriggerNotifications
Description

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

Federates the view for methods in this session. A federated view will include triggers in systems which are children of this system in the system hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedSystemView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableTriggerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableTriggerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeTriggerNotification
Description

Acknowledge a trigger notification.

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

Register for notifications of new triggers. TriggerReceiver.newTriggesr() is invoked when a new Trigger appears in this system.

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

Registers for notification of new triggers for the given controller. TriggerReceiver.newTriggers() is invoked a new Trigger appears in this system.

Parametersosid.id.IdcontrollerIdthe Id of the Controller to monitor
ErrorsNULL_ARGUMENT controllerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedTriggers
Description

Registers for notification of updated triggers. TriggerReceiver.changedTriggers() is invoked when a trigger in this system is changed.

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

Registers for notification of updated triggers for the given controller. TriggerReceiver.changedTriggers() is invoked when the specified trigger in this system is changed.

Parametersosid.id.IdcontrollerIdthe Id of the Controller to monitor
ErrorsNULL_ARGUMENT controllerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedTrigger
Description

Registers for notification of an updated trigger. TriggerReceiver.changedTriggers() is invoked when the specified trigger in this system is changed.

Parametersosid.id.IdtriggerIdthe Id of the Trigger to monitor
ErrorsNULL_ARGUMENT triggerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedTriggers
Description

Registers for notification of deleted triggers. TriggerReceiver.deletedTriggers() is invoked when a trigger is deleted or removed from this system.

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

Registers for notification of deleted triggers for the given controller. TriggerReceiver.deletedTrigger() is invoked when the specified trigger is deleted or removed from this system.

Parametersosid.id.IdcontrollerIdthe Id of the Controller to monitor
ErrorsNULL_ARGUMENT controllerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedTrigger
Description

Registers for notification of a deleted trigger. TriggerReceiver.deletedTriggers() is invoked when the specified trigger is deleted or removed from this system.

Parametersosid.id.IdtriggerIdthe Id of the Trigger to monitor
ErrorsNULL_ARGUMENT triggerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.