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

This session defines methods to receive notifications on adds/changes to AuditEnabler objects in this Inquest. This also includes existing AuditEnablers 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 AuditEnablerLookupSession.

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

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAuditEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAuditEnablerNotification
Description

Acknowledge an audit enabler notification.

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

Register for notifications of new audit enablers. AuditEnablerReceiver.newAuditEnablers() is invoked when a new AuditEnabler appears in this inquest.

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

Registers for notification of updated audit enablers. AuditEnablerReceiver.changedAuditEnablers() is invoked when an audit enabler in this inquest is changed.

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

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

Parametersosid.id.IdauditEnablerIdthe Id of the AuditEnabler to monitor
ErrorsNULL_ARGUMENT auditEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAuditEnablers
Description

Registers for notification of deleted audit enablers. AuditEnablerReceiver.deletedAuditEnablers() is invoked when an audit enabler is deleted or removed from this inquest.

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

Registers for notification of a deleted audit enabler. AuditEnablerReceiver.deletedAuditEnablers() is invoked when the specified audit enabler is deleted or removed from this inquest.

Parametersosid.id.IdauditEnablerIdthe Id of the AuditEnabler to monitor
ErrorsNULL_ARGUMENT auditEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.