public interface AssessmentTakenNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to AssessmentTaken
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
AssessmentTakenLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAssessmentTakenNotification(Id notificationId)
Acknowledge an assessment taken notification.
|
boolean |
canRegisterForAssessmentTakenNotifications()
Tests if this user can register for
AssessmentTaken
notifications. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
registerForChangedAssessmentsTaken()
Registers for notification of updated assessments taken.
|
void |
registerForChangedAssessmentsTakenForAssessment(Id assessmentId)
Register for notifications of changed assessments taken for an
assessment.
|
void |
registerForChangedAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId)
Register for notifications of changed assessments taken for an
assessment offered.
|
void |
registerForChangedAssessmentsTakenForTaker(Id resourceId)
Register for notifications of changed assessments taken for a
resource.
|
void |
registerForChangedAssessmentTaken(Id assessmentTakenId)
Registers for notification of an updated assessment taken.
|
void |
registerForDeletedAssessmentsTaken()
Registers for notification of deleted assessments taken.
|
void |
registerForDeletedAssessmentsTakenForAssessment(Id assessmentId)
Register for notifications of deleted assessments taken for an
assessment.
|
void |
registerForDeletedAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId)
Register for notifications of deleted assessments taken for an
assessment offered.
|
void |
registerForDeletedAssessmentsTakenForTaker(Id resourceId)
Register for notifications of deleted assessments taken for a
resource.
|
void |
registerForDeletedAssessmentTaken(Id assessmentTakenId)
Registers for notification of a deleted assessment taken.
|
void |
registerForNewAssessmentsTaken()
Register for notifications of new assessments taken in this assessment
bank.
|
void |
registerForNewAssessmentsTakenForAssessment(Id assessmentId)
Register for notifications of new assessments taken for an assessment.
|
void |
registerForNewAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId)
Register for notifications of new assessments taken for an assessment
offered.
|
void |
registerForNewAssessmentsTakenForTaker(Id resourceId)
Register for notifications of new assessments taken for a resource.
|
void |
reliableAssessmentTakenNotifications()
Reliable notifications are desired.
|
void |
unreliableAssessmentTakenNotifications()
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 canRegisterForAssessmentTakenNotifications()
AssessmentTaken
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 reliableAssessmentTakenNotifications()
acknowledgeAssessmentTakenNotification()
.mandatory
- This method is must be implemented. void unreliableAssessmentTakenNotifications()
mandatory
- This method is must be implemented. void acknowledgeAssessmentTakenNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAssessmentsTaken() throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.newAssessmentsTaken()
is
invoked when a new AssessmentTaken
appears in this
assessment bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForNewAssessmentsTakenForTaker(Id resourceId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.newAssessmenstTaken()
is
invoked when a new AssessmentTaken
appears in this
assessment bank.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForNewAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.newAssessmentsTaken()
is invoked when a new AssessmentTaken
appears in this
assessment bank.assessmentOfferedId
- the Id
of the
AssessmentOffered
to monitorNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForNewAssessmentsTakenForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.newAssessmentsTaken()
is
invoked when a new AssessmentTaken
appears in 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. void registerForChangedAssessmentsTaken() throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.changedAssessmentsTaken()
is invoked
when an assessment taken in this assessment bank is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForChangedAssessmentsTakenForTaker(Id resourceId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.changedAssessmentsTaken()
is invoked when an AssessmentTaken
is changed
in this assessment bank.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForChangedAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.changedAssessmentsTaken()
is invoked
when an AssessmentTaken
is changed in this assessment
bank.assessmentOfferedId
- the Id
of the
AssessmentOffered
to monitorNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForChangedAssessmentsTakenForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.changedAssessmentsTaken()
is invoked when an AssessmentTaken
is changed
in 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. void registerForChangedAssessmentTaken(Id assessmentTakenId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.changedAssessmentsTaken()
is invoked
when the specified assessment taken in this assessment bank is
changed.assessmentTakenId
- the Id
of the
AssessmentTaken
to monitorNullArgumentException
- assessmentTakenId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedAssessmentsTaken() throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.deletedAssessmentsTaken()
is invoked
when an assessment taken is removed from this assessment bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedAssessmentsTakenForTaker(Id resourceId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.deletedAssessmentsTaken()
is invoked when an AssessmentTaken
is removed
from this assessment bank.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedAssessmentsTakenForAssessmentOffered(Id assessmentOfferedId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.deletedAssessmentsTaken()
is invoked
when an AssessmentTaken
is removed from this assessment
bank.assessmentOfferedId
- the Id
of the
AssessmentOffered
to monitorNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedAssessmentsTakenForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.deletedAssessmentsTaken()
is invoked when an AssessmentTaken
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. void registerForDeletedAssessmentTaken(Id assessmentTakenId) throws OperationFailedException, PermissionDeniedException
AssessmentTakenReceiver.deletedAssessmentsTaken()
is invoked
when the specified assessment taken is removed from this assessment
bank.assessmentTakenId
- the Id
of the
AssessmentTaken
to monitorNullArgumentException
- assessmentTakenId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.