public interface AwardEntryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to AwardEntry
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
AwardEntryLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeAwardEntryNotification(Id notificationId)
Acknowledge an award entry notification.
|
boolean |
canRegisterForAwardEntryNotifications()
Tests if this user can register for
AwardEntry
notifications. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
void |
registerForChangedAwardEntries()
Registers for notification of updated award entries.
|
void |
registerForChangedAwardEntriesForAward(Id awardId)
Registers for notification of updated award entries for the given
award.
|
void |
registerForChangedAwardEntriesForStudent(Id resourceId)
Registers for notification of updated award entries for the given
student.
|
void |
registerForChangedAwardEntry(Id awardEntryId)
Registers for notification of an updated award entry.
|
void |
registerForDeletedAwardEntries()
Registers for notification of deleted award entries.
|
void |
registerForDeletedAwardEntriesForAward(Id awardId)
Registers for notification of deleted award entries for the given
award.
|
void |
registerForDeletedAwardEntriesForStudent(Id resourceId)
Registers for notification of deleted award entries for the given
student.
|
void |
registerForDeletedAwardEntry(Id awardEntryId)
Registers for notification of a deleted award entry.
|
void |
registerForNewAwardEntries()
Register for notifications of new award entries.
|
void |
registerForNewAwardEntriesForAward(Id awardId)
Registers for notification of new award entries for the given award.
|
void |
registerForNewAwardEntriesForStudent(Id resourceId)
Registers for notification of new award entries for the given student.
|
void |
reliableAwardEntryNotifications()
Reliable notifications are desired.
|
void |
unreliableAwardEntryNotifications()
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 canRegisterForAwardEntryNotifications()
AwardEntry
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 reliableAwardEntryNotifications()
acknowledgeAwardEntryNotification()
.mandatory
- This method is must be implemented. void unreliableAwardEntryNotifications()
mandatory
- This method is must be implemented. void acknowledgeAwardEntryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAwardEntries() throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.newAwardEntries()
is invoked when a new
AwardEntry
appears in this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAwardEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.newAwardEntries()
is invoked when a
new award 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 registerForNewAwardEntriesForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.newAwardEntries()
is invoked when a
new award entry appears in this course catalog.awardId
- the Id
of the Award
to
monitorNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAwardEntries() throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.changedAwardEntries()
is invoked when an
award entry in this course catalog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAwardEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.changedAwardEntries()
is
invoked when an award 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 registerForChangedAwardEntriesForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.changedAwardEntries()
is
invoked when an award entry is changed in this course catalog.awardId
- the Id
of the Award
to
monitorNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAwardEntry(Id awardEntryId) throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.changedAwardEntries()
is invoked when the
specified award entry in this course catalog is changed.awardEntryId
- the Id
of the AwardEntry
to monitorNullArgumentException
- awardEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAwardEntries() throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.deletedAwardEntries()
is invoked when an
award entry is deleted or removed from this course catalog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAwardEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.changedAwardEntries()
is
invoked when an award 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 registerForDeletedAwardEntriesForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.changedAwardEntries()
is
invoked when an award entry is deleted or removed from this course
catalog.awardId
- the Id
of the Award
to
monitorNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAwardEntry(Id awardEntryId) throws OperationFailedException, PermissionDeniedException
AwardEntryReceiver.deletedAwardEntries()
is invoked when the
specified award entry is deleted or removed from this course catalog.awardEntryId
- the Id
of the AwardEntry
to monitorNullArgumentException
- awardEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.