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

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

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

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableResponseNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeResponseNotification
Description

Acknowledge a response notification.

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

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

Register for notifications of new responses. ResponseReceiver.newResponses() is invoked when a new Response appears in this inquest.

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

Register for notifications of new responses for the given inquiry. ResponseReceiver.newResponses() is invoked when a new Response appears in 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.
MethodregisterForNewResponsesForResponder
Description

Register for notifications of new responses for the given resonder resource. ResponseReceiver.newResponses() is invoked when a new Response appears in this inquest.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedResponses
Description

Registers for notification of updated responses. ResponseReceiver.changedResponses() is invoked when a response in this inquest is changed.

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

Registers for notification of updated responses for the given inquiry. ResponseReceiver.changedResponses() is invoked when a response 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.
MethodregisterForChangedResponsesForResponder
Description

Registers for notification of updated responses for the given responder resource. ResponseReceiver.changedResponses() is invoked when a response in this inquest is changed.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedResponse
Description

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

Parametersosid.id.IdresponseIdthe Id of the Response to monitor
ErrorsNULL_ARGUMENT responseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedResponses
Description

Registers for notification of deleted responses. ResponseReceiver.deletedResponses() is invoked when a response is deleted or removed from this inquest.

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

Registers for notification of deleted responses for the given inquiry. ResponseReceiver.deletedResponses() is invoked when a response 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.
MethodregisterForDeletedResponsesForResponder
Description

Registers for notification of deleted responses for the given responder resource. ResponseReceiver.deletedResponses() is invoked when a response is deleted or removed from this inquest.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedResponse
Description

Registers for notification of a deleted response. ResponseReceiver.deletedResponses() is invoked when the specified response is deleted or removed from this inquest.

Parametersosid.id.IdresponseIdthe Id of the Response to monitor
ErrorsNULL_ARGUMENT responseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.