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

This session defines methods to receive notifications on adds/changes to TriggerEnabler objects in this System. This also includes existing TriggerEnablers 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 TriggerEnablerLookupSession.

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.
MethodcanRegisterForTriggerEnablerNotifications
Description

Tests if this user can register for TriggerEnabler 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 enablers 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.
MethodreliableTriggerEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableTriggerEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeTriggerEnablerNotification
Description

Acknowledge a trigger enabler notification.

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

Register for notifications of new trigger enablers. TriggerEnablerReceiver.newTriggerEnablers() is invoked when a new TriggerEnabler appears in this system.

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

Registers for notification of updated trigger enablers. TriggerEnablerReceiver.changedTriggerEnablers() is invoked when a trigger enabler in this system is changed.

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

Registers for notification of an updated trigger enabler. ProvisionableReceiver.changedTriggerEnablers() is invoked when the specified trigger enabler in this system is changed.

Parametersosid.id.IdtriggerEnablerIdthe Id of the TriggerEnabler to monitor
ErrorsNULL_ARGUMENT triggerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedTriggerEnablers
Description

Registers for notification of deleted trigger enablers. TriggerEnablerReceiver.deletedTriggerEnablers() is invoked when a trigger enabler is deleted or removed from this system.

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

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

Parametersosid.id.IdtriggerEnablerIdthe Id of the TriggerEnabler to monitor
ErrorsNULL_ARGUMENT triggerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.