public interface GradeSystemNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to GradeSystems
and the Grades defined within.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 |
---|---|
boolean |
canRegisterForGradeSystemNotifications()
Tests if this user can register for
GradeSystem
notifications. |
Gradebook |
getGradebook()
Gets the
Gradebook associated with this session. |
Id |
getGradebookId()
Gets the
Gradebook Id associated with
this session. |
void |
registerForChangedGradeSystem(Id gradeSystemId)
Registers for notification of an updated grade system.
|
void |
registerForChangedGradeSystems()
Registers for notification of updated grade systems.
|
void |
registerForDeletedGradeSystem(Id gradeSystemId)
Registers for notification of a deleted grade system.
|
void |
registerForDeletedGradeSystems()
Registers for notification of deleted grade systems.
|
void |
registerForNewGradeSystems()
Register for notifications of new grade systems.
|
void |
useFederatedGradebookView()
Federates the view for methods in this session.
|
void |
useIsolatedGradebookView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGradebookId()
Gradebook
Id
associated with
this session. Gradebook Id
associated with this sessionmandatory
- This method must be implemented. Gradebook getGradebook() throws OperationFailedException, PermissionDeniedException
Gradebook
associated with this session. Gradebook
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForGradeSystemNotifications()
GradeSystem
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 useFederatedGradebookView()
mandatory
- This method is must be implemented. void useIsolatedGradebookView()
mandatory
- This method is must be implemented. void registerForNewGradeSystems() throws OperationFailedException, PermissionDeniedException
GradeSystemReceiver.newGradeSystems()
is invoked when a new
GradeSystem
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedGradeSystems() throws OperationFailedException, PermissionDeniedException
GradeSystemReceiver.changedGradeSystems()
is invoked when a
system is changed or grades are changed within it.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedGradeSystem(Id gradeSystemId) throws OperationFailedException, PermissionDeniedException
GradeSystemReceiver.changedGradeSystems()
is invoked when the
specified grade system is changed or grades are changed within it.gradeSystemId
- the Id
of the grade system to
monitorNullArgumentException
- gradeSystemId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedGradeSystems() throws OperationFailedException, PermissionDeniedException
GradeSystemReceiver.deletedGradeSystems()
is invoked when a
grade system is removed from this gradebook.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedGradeSystem(Id gradeSystemId) throws OperationFailedException, PermissionDeniedException
GradeSystemReceiver.deletedGradeSystems()
is invoked when the
specified system is removed from this gradebook.gradeSystemId
- the Id
of the grade system to
monitorNullArgumentException
- gradeSystemId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.