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

This session defines methods to receive notifications on adds/changes to Inquiry objects in this Inquest. 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.

The two views defined in this session correspond to the views in the InquiryLookupSession.

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

Federates the view for methods in this session. A federated view will include inquiries 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.
MethodreliableInquiryNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableInquiryNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeInquiryNotification
Description

Acknowledge an inquiry notification.

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

Register for notifications of new inquiries. 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.
MethodregisterForNewInquiriesForAudit
Description

Register for notifications of new inquiries for the given audit Id. InquiryReceiver.newInquiries() is invoked when a new Inquiry is created.

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

Registers for notification of updated inquiries. InquiryReceiver.changedInquiries() is invoked when an inquiry in this inquest is changed.

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

Register for notifications of updated inquiries for the given audit Id. InquiryReceiver.changedInquiries() is invoked when an inquiry 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.
MethodregisterForChangedInquiry
Description

Registers for notification of an updated inquiry. InquiryReceiver.changedInquiries() is invoked when the specified inquiry in this inquest is changed.

Parametersosid.id.IdinquiryIdthe Id of the Inquiry to monitor
ErrorsNULL_ARGUMENT inquiryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedInquiries
Description

Registers for notification of deleted inquiries. InquiryReceiver.deletedInquiries() is invoked when an inquiry is deleted or removed from this inquest.

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

Register for notifications of deleted inquiries for the given audit Id. InquiryReceiver.deletedInquiries() is invoked when an inquiry in this inquest is removed or deleted.

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

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

Parametersosid.id.IdinquiryIdthe Id of the Inquiry to monitor
ErrorsNULL_ARGUMENT inquiryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.