public interface AssessmentNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Assessment
objects in this Bank.
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
AssessmentLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAssessmentNotification(Id notificationId)
Acknowledge an assessment notification.
|
boolean |
canRegisterForAssessmentNotifications()
Tests if this user can register for
Assessment
notifications. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
registerForChangedAssessment(Id assessmentId)
Registers for notification of an updated assessment.
|
void |
registerForChangedAssessments()
Registers for notification of updated assessments.
|
void |
registerForDeletedAssessment(Id assessmentId)
Registers for notification of a deleted assessment.
|
void |
registerForDeletedAssessments()
Registers for notification of deleted assessments.
|
void |
registerForNewAssessments()
Register for notifications of new assessments.
|
void |
reliableAssessmentNotifications()
Reliable notifications are desired.
|
void |
unreliableAssessmentNotifications()
Unreliable notifications are desired.
|
void |
useFederatedBankView()
Federates the view for methods in this session.
|
void |
useIsolatedBankView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBankId()
Bank
Id
associated with this
session. Bank Id
associated with this sessionmandatory
- This method must be implemented. Bank getBank() throws OperationFailedException, PermissionDeniedException
Bank
associated with this session. Bank
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForAssessmentNotifications()
Assessment
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 useFederatedBankView()
mandatory
- This method is must be implemented. void useIsolatedBankView()
mandatory
- This method is must be implemented. void reliableAssessmentNotifications()
acknowledgeAssessmentNotification()
.mandatory
- This method is must be implemented. void unreliableAssessmentNotifications()
mandatory
- This method is must be implemented. void acknowledgeAssessmentNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAssessments() throws OperationFailedException, PermissionDeniedException
AssessmentReceiver.newAssessments()
is invoked when a new
Assessment
appears in this assessment bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForChangedAssessments() throws OperationFailedException, PermissionDeniedException
AssessmentReceiver.changedAssessments()
is invoked when an
assessment in this assessment bank is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForChangedAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentReceiver.changedAssessments()
is invoked when the
specified assessment in this assessment bank is changed.assessmentId
- the Id
of the Assessment
to monitorNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedAssessments() throws OperationFailedException, PermissionDeniedException
AssessmentReceiver.deletedAssessments()
is invoked when an
assessment is removed from this assessment bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentReceiver.deletedAssessments()
is invoked when the
specified assessment is removed from this assessment bank.assessmentId
- the Id
of the Assessment
to monitorNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.