public interface SyllabusNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Syllabus
objects. 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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeSyllabusNotification(Id notificationId)
Acknowledge a syllabus notification.
|
boolean |
canRegisterForSyllabusNotifications()
Tests if this user can register for
Syllabus
notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedSyllabi()
Registers for notification of updated syllabi.
|
void |
registerForChangedSyllabiForCourse(Id courseId)
Register for notifications of changed syllabi for the given course
Id. |
void |
registerForChangedSyllabus(Id syllabusId)
Registers for notification of an updated syllabus.
|
void |
registerForDeletedSyllabi()
Registers for notification of deleted syllabi.
|
void |
registerForDeletedSyllabiForCourse(Id courseId)
Register for notifications of deleted syllabi for the given course
Id. |
void |
registerForDeletedSyllabus(Id syllabusId)
Registers for notification of a deleted syllabus.
|
void |
registerForNewSyllabi()
Register for notifications of new syllabi.
|
void |
registerForNewSyllabiForCourse(Id courseId)
Register for notifications of new syllabi for the given course
. |
void |
reliableSyllabusNotifications()
Reliable notifications are desired.
|
void |
unreliableSyllabusNotifications()
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 canRegisterForSyllabusNotifications()
Syllabus
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 reliableSyllabusNotifications()
acknowledgeSyllabusNotification()
.mandatory
- This method is must be implemented. void unreliableSyllabusNotifications()
mandatory
- This method is must be implemented. void acknowledgeSyllabusNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSyllabi() throws OperationFailedException, PermissionDeniedException
SyllabusReceiver.newSyllabi()
is invoked when a new
Syllabus
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSyllabiForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
.
SyllabusReceiver.newSyllabi()
is invoked when
a new Syllabus
is created.courseId
- the Id
of the course to monitorNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSyllabi() throws OperationFailedException, PermissionDeniedException
SyllabusReceiver.changedSyllabi()
is invoked when a syllabus
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSyllabiForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
Id.
SyllabusReceiver.changedSyllabi()
is
invoked when a Syllabus
for the coursein this catalog
is changed.courseId
- the Id
of the course to monitorNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
SyllabusReceiver.changedSyllabi()
is invoked when the
specified syllabus is changed.syllabusId
- the Id
of the Syllabus
to monitorNullArgumentException
- syllabusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSyllabi() throws OperationFailedException, PermissionDeniedException
SyllabusReceiver.deletedSyllabi()
is invoked when a syllabus
is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSyllabiForCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
Id.
SyllabusReceiver.deletedSyllabi()
is
invoked when a Syllabus
for the course in this catalog
is deleted.courseId
- the Id
of the course to monitorNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSyllabus(Id syllabusId) throws OperationFailedException, PermissionDeniedException
SyllabusReceiver.deletedSyllabi()
is invoked when the
specified syllabus is deleted.syllabusId
- the Id
of the Syllabus
to monitorNullArgumentException
- syllabusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.