public interface AcknowledgementNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForInquiryNotifications()
Tests if this user can register for
Inquiry
notifications. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
registerForNewInquiries()
Register for notifications of new inquiries needing responses for
resources related to the authenticated agent.
|
void |
registerForNewInquiriesToAcknowledge(Id auditId)
Register for notifications of new inquiries needing responses for the
given audit
Id for resources related to the
authenticated agent. |
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 canRegisterForInquiryNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void registerForNewInquiries() throws OperationFailedException, PermissionDeniedException
InquiryReceiver.newInquiries()
is invoked when a new
Inquiry
appears in this inquest.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewInquiriesToAcknowledge(Id auditId) throws OperationFailedException, PermissionDeniedException
Id
for resources related to the
authenticated agent. InquiryReceiver.newInquiries()
is
invoked when a new Inquiry
needs a response.auditId
- the Id
of the audit to monitorNullArgumentException
- auditId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.