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

This session defines methods to receive notifications on adds/changes to Inquiry objects in this Inquest for resources related to the authenticated agent. This also includes existing inquiries 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.

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

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

Register for notifications of new inquiries needing responses for resources related to the authenticated agent. InquiryReceiver.newInquiries() is invoked when a new Inquiry appears in this inquest.

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

Register for notifications of new inquiries needing responses for the given audit Id for resources related to the authenticated agent. InquiryReceiver.newInquiries() is invoked when a new Inquiry needs a response.

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.