org.osid.grading

Interface GradebookNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface GradebookNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Gradebook 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForGradebookNotifications() Tests if this user can register for Gradebook notifications.
void	registerForChangedGradebook(Id gradebookId) Registers for notification of an updated gradebook.
void	registerForChangedGradebooks() Registers for notification of updated gradebooks.
void	registerForDeletedGradebook(Id gradebookId) Registers for notification of a deleted gradebook.
void	registerForDeletedGradebookAncestors(Id gradebookId) Registers for notification if an ancestor is removed from the specified gradebook in the gradebook hierarchy.
void	registerForDeletedGradebookDescendants(Id gradebookId) Registers for notification if a descendant is removed from fthe specified gradebook in the calndar hierarchy.
void	registerForDeletedGradebooks() Registers for notification of deleted gradebooks.
void	registerForNewGradebookAncestors(Id gradebookId) Registers for notification if an ancestor is added to the specified gradebook in the gradebook hierarchy.
void	registerForNewGradebookDescendants(Id gradebookId) Registers for notification if a descendant is added to the specified gradebook in the gradebook hierarchy.
void	registerForNewGradebooks() Register for notifications of new gradebooks.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canRegisterForGradebookNotifications

boolean canRegisterForGradebookNotifications()

Tests if this user can register for Gradebook 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

registerForNewGradebooks

void registerForNewGradebooks()
                              throws OperationFailedException,
                                     PermissionDeniedException

Register for notifications of new gradebooks. GradebookReceiver.newGradebooks() is invoked when a new Gradebook is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewGradebookAncestors

void registerForNewGradebookAncestors(Id gradebookId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification if an ancestor is added to the specified gradebook in the gradebook hierarchy. GradebookReceiver.newGradebookAncestor() is invoked when the specified gradebook experiences an addition in ancestry.

Parameters:

gradebookId - the Id of the gradebook to monitor

Throws:

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewGradebookDescendants

void registerForNewGradebookDescendants(Id gradebookId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification if a descendant is added to the specified gradebook in the gradebook hierarchy. GradebookReceiver.newGradebookDescendant() is invoked when the specified gradebook experiences an addition in descendants.

Parameters:

gradebookId - the Id of the gradebook to monitor

Throws:

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedGradebooks

void registerForChangedGradebooks()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of updated gradebooks. GradebookReceiver.changedGradebooks() is invoked when a gradebook is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedGradebook

void registerForChangedGradebook(Id gradebookId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of an updated gradebook. GradebookReceiver.changedGradebooks() is invoked when the specified gradebook is changed.

Parameters:

gradebookId - the Id of the gradebook to monitor

Throws:

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGradebooks

void registerForDeletedGradebooks()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of deleted gradebooks. GradebookReceiver.deletedGradebooks() is invoked when a calenedar is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGradebook

void registerForDeletedGradebook(Id gradebookId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of a deleted gradebook. GradebookReceiver.deletedGradebooks() is invoked when the specified gradebook is deleted.

Parameters:

gradebookId - the Id of the gradebook to monitor

Throws:

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGradebookAncestors

void registerForDeletedGradebookAncestors(Id gradebookId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification if an ancestor is removed from the specified gradebook in the gradebook hierarchy. GradebookReceiver.deletedGradebookAncestor() is invoked when the specified gradebook experiences a removal of an ancestor.

Parameters:

gradebookId - the Id of the gradebook to monitor

Throws:

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGradebookDescendants

void registerForDeletedGradebookDescendants(Id gradebookId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification if a descendant is removed from fthe specified gradebook in the calndar hierarchy. GradebookReceiver.deletedGradebookDescednant() is invoked when the specified gradebook experiences a removal of one of its descendants.

Parameters:

gradebookId - the Id of the gradebook to monitor

Throws:

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.