public interface AssessmentEntryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to AssessmentEntry
objects in this CourseCatalog.
This also includes existing courses that may appear or disappear
due to changes in the CourseCatalog
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
AssessmentEntryLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAssessmentEntryNotification(Id notificationId)
Acknowledge an assessmeny entry notification.
|
boolean |
canRegisterForAssessmentEntryNotifications()
Tests if this user can register for
AssessmentEntry
notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedAssessmentEntries()
Registers for notification of updated assessment entries.
|
void |
registerForChangedAssessmentEntriesForAssessment(Id assessmentId)
Registers for notification of updated assessment entries for the given
assessment.
|
void |
registerForChangedAssessmentEntriesForStudent(Id resourceId)
Registers for notification of updated assessment entries for the given
student.
|
void |
registerForChangedAssessmentEntry(Id assessmentEntryId)
Registers for notification of an updated assessment entry.
|
void |
registerForDeletedAssessmentEntries()
Registers for notification of deleted assessment entries.
|
void |
registerForDeletedAssessmentEntriesForAssessment(Id assessmentId)
Registers for notification of deleted assessment entries for the given
assessment.
|
void |
registerForDeletedAssessmentEntriesForStudent(Id resourceId)
Registers for notification of deleted assessment entries for the given
student.
|
void |
registerForDeletedAssessmentEntry(Id assessmentEntryId)
Registers for notification of a deleted assessment entry.
|
void |
registerForNewAssessmentEntries()
Register for notifications of new assessment entries.
|
void |
registerForNewAssessmentEntriesForAssessment(Id assessmentId)
Registers for notification of new assessment entries for the given
assessment.
|
void |
registerForNewAssessmentEntriesForStudent(Id resourceId)
Registers for notification of new assessment entries for the given
student.
|
void |
reliableAssessmentEntryNotifications()
Reliable notifications are desired.
|
void |
unreliableAssessmentEntryNotifications()
Unreliable notifications are desired.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForAssessmentEntryNotifications()
AssessmentEntry
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 useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void reliableAssessmentEntryNotifications()
acknowledgeAssessmentEntryNotification()
.mandatory
- This method is must be implemented. void unreliableAssessmentEntryNotifications()
mandatory
- This method is must be implemented. void acknowledgeAssessmentEntryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAssessmentEntries() throws OperationFailedException, PermissionDeniedException
AssessmentEntryReceiver.newAssessmentEntries()
is invoked when
a new AssessmentEntry
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAssessmentEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
AssessmentlEntryReceiver.newAssessmentEntries()
is invoked when a new assessment entry appears in this course
catalog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAssessmentEntriesForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentlEntryReceiver.newAssessmentEntries()
is invoked when a new assessment entry appears in this course
catalog.assessmentId
- the Id
of the Assessment
to monitorNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAssessmentEntries() throws OperationFailedException, PermissionDeniedException
AssessmentEntryReceiver.changedAssessmentEntries()
is invoked
when an assessment entry in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAssessmentEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
AssessmentlEntryReceiver.changedAssessmentEntries()
is invoked when an assessment entry is changed in this course
catalog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAssessmentEntriesForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentlEntryReceiver.changedAssessmentEntries()
is invoked when an assessment entry is changed in this course
catalog.assessmentId
- the Id
of the Assessment
to monitorNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAssessmentEntry(Id assessmentEntryId) throws OperationFailedException, PermissionDeniedException
AssessmentEntryReceiver.changedAssessmentEntries()
is invoked
when the specified assessment entry in this course catalog is changed.assessmentEntryId
- the Id
of the
AssessmentEntry
to monitorNullArgumentException
- assessmentEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAssessmentEntries() throws OperationFailedException, PermissionDeniedException
AssessmentEntryReceiver.deletedAssessmentEntries()
is invoked
when an assessment entry is deleted or removed from this course
catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAssessmentEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
AssessmentlEntryReceiver.deletedAssessmentEntries()
is invoked when an assessment entry is deleted or removed from
this course catalog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAssessmentEntriesForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentlEntryReceiver.deletedAssessmentEntries()
is invoked when an assessment entry is deleted or removed from
this course catalog.assessmentId
- the Id
of the Assessment
to monitorNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAssessmentEntry(Id assessmentEntryId) throws OperationFailedException, PermissionDeniedException
AssessmentEntryReceiver.deletedAssessmentEntries()
is invoked
when the specified assessment entry is deleted or removed from this
course catalog.assessmentEntryId
- the Id
of the
AssessmentEntry
to monitorNullArgumentException
- assessmentEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.