public interface ResponseNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeResponseNotification(Id notificationId)
Acknowledge a response notification.
|
boolean |
canRegisterForResponseNotifications()
Tests if this user can register for
Response
notifications. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
registerForChangedResponse(Id responseId)
Registers for notification of an updated response.
|
void |
registerForChangedResponses()
Registers for notification of updated responses.
|
void |
registerForChangedResponsesForInquiry(Id inquiryId)
Registers for notification of updated responses for the given inquiry.
|
void |
registerForChangedResponsesForResponder(Id resourceId)
Registers for notification of updated responses for the given
responder resource.
|
void |
registerForDeletedResponse(Id responseId)
Registers for notification of a deleted response.
|
void |
registerForDeletedResponses()
Registers for notification of deleted responses.
|
void |
registerForDeletedResponsesForInquiry(Id inquiryId)
Registers for notification of deleted responses for the given inquiry.
|
void |
registerForDeletedResponsesForResponder(Id resourceId)
Registers for notification of deleted responses for the given
responder resource.
|
void |
registerForNewResponses()
Register for notifications of new responses.
|
void |
registerForNewResponsesForInquiry(Id inquiryId)
Register for notifications of new responses for the given inquiry.
|
void |
registerForNewResponsesForResponder(Id resourceId)
Register for notifications of new responses for the given resonder
resource.
|
void |
reliableResponseNotifications()
Reliable notifications are desired.
|
void |
unreliableResponseNotifications()
Unreliable notifications are desired.
|
void |
useFederatedInquestView()
Federates the view for methods in this session.
|
void |
useIsolatedInquestView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getInquestId()
Inquest
Id
associated with this
session. Inquest Id
associated with this sessionmandatory
- This method must be implemented. Inquest getInquest() throws OperationFailedException, PermissionDeniedException
Inquest
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForResponseNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void reliableResponseNotifications()
acknowledgeResponseNotification()
.mandatory
- This method is must be implemented. void unreliableResponseNotifications()
mandatory
- This method is must be implemented. void acknowledgeResponseNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void useFederatedInquestView()
mandatory
- This method is must be implemented. void useIsolatedInquestView()
mandatory
- This method is must be implemented. void registerForNewResponses() throws OperationFailedException, PermissionDeniedException
ResponseReceiver.newResponses()
is invoked when a new
Response
appears in this inquest.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewResponsesForInquiry(Id inquiryId) throws OperationFailedException, PermissionDeniedException
ResponseReceiver.newResponses()
is invoked when a new
Response
appears in this inquest.inquiryId
- the Id
of the inquiry to monitorNullArgumentException
- inquiryId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewResponsesForResponder(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResponseReceiver.newResponses()
is invoked
when a new Response
appears in this inquest.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedResponses() throws OperationFailedException, PermissionDeniedException
ResponseReceiver.changedResponses()
is invoked when a response
in this inquest is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedResponsesForInquiry(Id inquiryId) throws OperationFailedException, PermissionDeniedException
ResponseReceiver.changedResponses()
is invoked when a
response in this inquest is changed.inquiryId
- the Id
of the inquiry to monitorNullArgumentException
- inquiryId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedResponsesForResponder(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResponseReceiver.changedResponses()
is invoked when a response in this inquest is changed.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedResponse(Id responseId) throws OperationFailedException, PermissionDeniedException
ResponseReceiver.changedResponses()
is invoked when the
specified response in this inquest is changed.responseId
- the Id
of the Response
to monitorNullArgumentException
- responseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedResponses() throws OperationFailedException, PermissionDeniedException
ResponseReceiver.deletedResponses()
is invoked when a response
is deleted or removed from this inquest.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedResponsesForInquiry(Id inquiryId) throws OperationFailedException, PermissionDeniedException
ResponseReceiver.deletedResponses()
is invoked when a
response is deleted or removed from this inquest.inquiryId
- the Id
of the inquiry to monitorNullArgumentException
- inquiryId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedResponsesForResponder(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResponseReceiver.deletedResponses()
is invoked when a response is deleted or removed from this inquest.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedResponse(Id responseId) throws OperationFailedException, PermissionDeniedException
ResponseReceiver.deletedResponses()
is invoked when the
specified response is deleted or removed from this inquest.responseId
- the Id
of the Response
to monitorNullArgumentException
- responseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.