org.osid.grading.transform

Interface GradeSystemTransformNotificationSession

All Superinterfaces:

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

public interface GradeSystemTransformNotificationSession
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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForGradeSystemTransformNotifications() Tests if this user can register for GradeSystemTransform notifications.
Gradebook	getGradebook() Gets the Gradebook associated with this session.
Id	getGradebookId() Gets the Gradebook Id associated with this session.
void	registerForChangedGradeSystemTransform(Id gradeSystemTransformId) Registers for notification of an updated grade system transform.
void	registerForChangedGradeSystemTransforms() Registers for notification of updated grade system transforms.
void	registerForDeletedGradeSystemTransform(Id gradeSystemTransformId) Registers for notification of a deleted grade system transform.
void	registerForDeletedGradeSystemTransforms() Registers for notification of deleted grade system transforms.
void	registerForNewGradeSystemTransforms() Register for notifications of new grade system transforms.
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.

canRegisterForGradeSystemTransformNotifications

boolean canRegisterForGradeSystemTransformNotifications()

Tests if this user can register for GradeSystemTransform 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 grade system transforms 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.

registerForNewGradeSystemTransforms

void registerForNewGradeSystemTransforms()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Register for notifications of new grade system transforms. GradeSystemTransformReceiver.newGradeSystemTransforms() is invoked when a new GradeSystemTransform is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedGradeSystemTransforms

void registerForChangedGradeSystemTransforms()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of updated grade system transforms. GradeSystemTransformReceiver.changedGradeSystemTransforms() is invoked when a transform is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedGradeSystemTransform

void registerForChangedGradeSystemTransform(Id gradeSystemTransformId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification of an updated grade system transform. GradeSystemTransformReceiver.changedGradeSystemTransforms() is invoked when the specified grade system transform is changed.

Parameters:

gradeSystemTransformId - the Id of the grade system transform to monitor

Throws:

NullArgumentException - gradeSystemTransformId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGradeSystemTransforms

void registerForDeletedGradeSystemTransforms()
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Registers for notification of deleted grade system transforms. GradeSystemTransformReceiver.deletedGradeSystemTransforms() is invoked when a grade system transform is removed from this gradebook.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedGradeSystemTransform

void registerForDeletedGradeSystemTransform(Id gradeSystemTransformId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Registers for notification of a deleted grade system transform. GradeSystemTransformReceiver.deletedGradeSystemTransforms() is invoked when the specified system transform is removed from this gradebook.

Parameters:

gradeSystemTransformId - the Id of the grade system transform to monitor

Throws:

NullArgumentException - gradeSystemTransformId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.