org.osid.grading

Interface GradebookColumnNotificationSession

All Superinterfaces:

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

public interface GradebookColumnNotificationSession
extends OsidSession

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

The views defined in this session correspond to the views in the GradebookColumnLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForGradebookColumnNotifications() Tests if this user can register for GradebookColumn notifications.
Gradebook	getGradebook() Gets the Gradebook associated with this session.
Id	getGradebookId() Gets the Gradebook Id associated with this session.
void	registerForChangedGradebookColumn(Id gradebookColumnId) Registers for notification of an updated gradebook column.
void	registerForChangedGradebookColumns() Registers for notification of updated gradebook columns.
void	registerForDeletedGradebookColumn(Id gradebookColumnId) Registers for notification of a deleted gradebook column.
void	registerForDeletedGradebookColumns() Registers for notification of deleted gradebook columns.
void	registerForNewGradebookColumns() Register for notifications of new gradebook columns.
void	useFederatedGradebookView() Federates the view for methods in this session.
void	useIsolatedGradebookView() Isolates the view for methods in this session.

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

getGradebookId

Id getGradebookId()

Gets the Gradebook Id associated with this session.

Returns:

the Gradebook Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGradebook

Gradebook getGradebook()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Gradebook associated with this session.

Returns:

the Gradebook associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForGradebookColumnNotifications

boolean canRegisterForGradebookColumnNotifications()

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

useFederatedGradebookView

void useFederatedGradebookView()

Federates the view for methods in this session. A federated view will include notifications for gradebook columns in gradebooks which are children of this gradebook in the gradebook hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedGradebookView

void useIsolatedGradebookView()

Isolates the view for methods in this session. An isolated view restricts notifications to this gradebook only.

Compliance:

mandatory - This method is must be implemented.

registerForNewGradebookColumns

void registerForNewGradebookColumns()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Register for notifications of new gradebook columns. GradebookColumnReceiver.newGradebookColumns() is invoked when a new column is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedGradebookColumns

void registerForChangedGradebookColumns()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification of updated gradebook columns. GradebookColumnReceiver.changedGradebookColumns() is invoked when a gradebook column is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedGradebookColumn

void registerForChangedGradebookColumn(Id gradebookColumnId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Registers for notification of an updated gradebook column. GradebookColumnReceiver.changedGradebookColumns() is invoked when the specified gradebook column is changed.

Parameters:

gradebookColumnId - the Id of the GradebookColumn to monitor

Throws:

NullArgumentException - gradebookColumnId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGradebookColumns

void registerForDeletedGradebookColumns()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification of deleted gradebook columns. GradebookColumnReceiver.deletedGradebookColumns() is invoked when a gradebook column is removed from this gradebook.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGradebookColumn

void registerForDeletedGradebookColumn(Id gradebookColumnId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Registers for notification of a deleted gradebook column. GradebookColumnReceiver.deletedGradebookColumns() is invoked when the specified column is removed from thia gradebook.

Parameters:

gradebookColumnId - the Id of the GradebookColumn to monitor

Throws:

NullArgumentException - gradebookColumnId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.