OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.InquiryEnablerNotificationSession
Implementsosid.OsidSession
Description

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

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Idthe Inquest Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquestthe inquest
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForInquiryEnablerNotifications
Description

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

Federates the view for methods in this session. A federated view will include enablers in inquests which are children of this inquest in the inquest hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedInquestView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableInquiryEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableInquiryEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeInquiryEnablerNotification
Description

Acknowledge an inquiru enabler notification.

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

Register for notifications of new inquiry enablers. InquiryEnablerReceiver.newInquiryEnablers() is invoked when a new InquiryEnabler appears in this inquest.

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

Registers for notification of updated inquiry enablers. InquiryEnablerReceiver.changedInquiryEnablers() is invoked when an inquiry enabler in this inquest is changed.

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

Registers for notification of an updated inquiry enabler. ProvisionableReceiver.changedInquiryEnablers() is invoked when the specified inquiry enabler in this inquest is changed.

Parametersosid.id.IdinquiryEnablerIdthe Id of the InquiryEnabler to monitor
ErrorsNULL_ARGUMENT inquiryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedInquiryEnablers
Description

Registers for notification of deleted inquiry enablers. InquiryEnablerReceiver.deletedInquiryEnablers() is invoked when an inquiry enabler is deleted or removed from this inquest.

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

Registers for notification of a deleted inquiry enabler. InquiryEnablerReceiver.deletedInquiryEnablers() is invoked when the specified inquiry enabler is deleted or removed from this inquest.

Parametersosid.id.IdinquiryEnablerIdthe Id of the InquiryEnabler to monitor
ErrorsNULL_ARGUMENT inquiryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.