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

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

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

Tests if this user can register for Audit 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 audits 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.
MethodreliableAuditNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableAuditNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeAuditNotification
Description

Acknowledge an audit notification.

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

Register for notifications of new audits. AuditReceiver.newAudits() is invoked when a new Audit appears in this inquest.

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

Registers for notification of updated audits. AuditReceiver.changedAudits() is invoked when an audit in this inquest is changed.

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

Registers for notification of an updated audit. ResponseReceiver.changedAudits() is invoked when the specified audit in this inquest is changed.

Parametersosid.id.IdauditIdthe Id of the Audit to monitor
ErrorsNULL_ARGUMENT auditId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAudits
Description

Registers for notification of deleted audits. AuditReceiver.deletedAudits() is invoked when an audit is deleted or removed from this inquest.

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

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

Parametersosid.id.IdauditIdthe Id of the Audit to monitor
ErrorsNULL_ARGUMENT auditId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.