public interface AuditNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Audit
objects in this Inquest.
This also
includes existing audits 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
AuditLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAuditNotification(Id notificationId)
Acknowledge an audit notification.
|
boolean |
canRegisterForAuditNotifications()
Tests if this user can register for
Audit
notifications. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
registerForChangedAudit(Id auditId)
Registers for notification of an updated audit.
|
void |
registerForChangedAudits()
Registers for notification of updated audits.
|
void |
registerForDeletedAudit(Id auditId)
Registers for notification of a deleted audit.
|
void |
registerForDeletedAudits()
Registers for notification of deleted audits.
|
void |
registerForNewAudits()
Register for notifications of new audits.
|
void |
reliableAuditNotifications()
Reliable notifications are desired.
|
void |
unreliableAuditNotifications()
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 canRegisterForAuditNotifications()
Audit
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 useFederatedInquestView()
mandatory
- This method is must be implemented. void useIsolatedInquestView()
mandatory
- This method is must be implemented. void reliableAuditNotifications()
acknowledgeUDITNotification()
.mandatory
- This method is must be implemented. void unreliableAuditNotifications()
mandatory
- This method is must be implemented. void acknowledgeAuditNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAudits() throws OperationFailedException, PermissionDeniedException
AuditReceiver.newAudits()
is invoked when a new Audit
appears in this inquest.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAudits() throws OperationFailedException, PermissionDeniedException
AuditReceiver.changedAudits()
is invoked when an audit in this
inquest is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAudit(Id auditId) throws OperationFailedException, PermissionDeniedException
ResponseReceiver.changedAudits()
is invoked when the specified
audit in this inquest is changed.auditId
- the Id
of the Audit
to
monitorNullArgumentException
- auditId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAudits() throws OperationFailedException, PermissionDeniedException
AuditReceiver.deletedAudits()
is invoked when an audit is
deleted or removed from this inquest.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAudit(Id auditId) throws OperationFailedException, PermissionDeniedException
AuditReceiver.deletedAudits()
is invoked when the specified
audit is deleted or removed from this inquest.auditId
- the Id
of the Audit
to
monitorNullArgumentException
- auditId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.