public interface AssessmentPartNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to AssessmentPart
objects in this Bank.
This
also includes existing AssessmentParts
that may appear or
disappear due to changes in the Bank
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
AssessmentPartLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAssessmentPartNotification(Id notificationId)
Acknowledge an assessment part notification.
|
boolean |
canRegisterForAssessmentPartNotifications()
Tests if this user can register for
AssessmentPart
notifications. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
registerForChangedAssessmentPart(Id assessmentPartId)
Registers for notification of an updated assessment part.
|
void |
registerForChangedAssessmentParts()
Registers for notification of updated bank.
|
void |
registerForDeletedAssessmentPart(Id assessmentPartId)
Registers for notification of a deleted assessment part.
|
void |
registerForDeletedAssessmentParts()
Registers for notification of deleted assessment parts.
|
void |
registerForNewAssessmentParts()
Register for notifications of new assessment parts.
|
void |
reliableAssessmentPartNotifications()
Reliable notifications are desired.
|
void |
unreliableAssessmentPartNotifications()
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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForAssessmentPartNotifications()
AssessmentPart
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 reliableAssessmentPartNotifications()
acknowledgeAssessmentPartNotification()
.mandatory
- This method is must be implemented. void unreliableAssessmentPartNotifications()
mandatory
- This method is must be implemented. void acknowledgeAssessmentPartNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAssessmentParts() throws OperationFailedException, PermissionDeniedException
AssessmentPartReceiver.newAssessmentParst()
is invoked when a
new AssessmentPart
appears in this bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAssessmentParts() throws OperationFailedException, PermissionDeniedException
AssessmentPartReceiver.changedAssessmentParts()
is invoked
when an assessment part in this bank is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAssessmentPart(Id assessmentPartId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedAssessmentParts()
is invoked when
the specified assessment part in this bank is changed.assessmentPartId
- the Id
of the
AssessmentPart
to monitorNotFoundException
- an assessment part was not found in
this step matchmaker identified by the given Id
NullArgumentException
- assessmentPartId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAssessmentParts() throws OperationFailedException, PermissionDeniedException
AssessmentPartReceiver.deletedAssessmentParts()
is invoked
when an assessment part is deleted or removed from this bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAssessmentPart(Id assessmentPartId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentPartReceiver.deletedAssessmentParts()
is invoked
when the specified assessment part is deleted or removed from this
bank.assessmentPartId
- the Id
of the
AssessmentPart
to monitorNotFoundException
- an assessment part was not found in
this step matchmaker identified by the given Id
NullArgumentException
- assessmentPartId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.