org.osid.grading

Interface GradingProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, GradingProfile, OsidProfile, OsidProxyManager, Sourceable

public interface GradingProxyManager
extends OsidProxyManager, GradingProfile

The grading manager provides access to grading sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from server environments.The sessions included in this manager are:

• GradeSystemLookupSession: a session to look up grades and grade systems
• GradeSystemQuerySession: a session to query grade systems
• GradeSystemSearchSession: a session to search grade systems
• GradeSystemAdminSession: a session to manage grade systems
• GradeSystemNotificationSession a session for subscribing to new or deleted grades or grade systems
• GradeSystemGradebookSession: a session for retrieving grade system to gradebook mappings
• GradeSystemGradebookAssignmentSession: a session for managing grade system to gradebook mappings
• GradeSystemSmartGradebookSession: a session for managing smart gradebooks of grade systems

• GradeEntryLookupSession: a session to look up grade entries
• GradeEntryQuerySession: a session to query grade entries
• GradeEntrySearchSession: a session to search grade entries
• GradeEntryAdminSession: a session to create, modify and delete grade entries
• GradeEntryNotificationSession: a session to receive messages pertaining to grade entry changes

• GradebookColumnLookupSession: a session to look up gradebook columns
• GradebookColumnQuerySession: a session to query gradebook columns
• GradebookColumnSearchSession: a session to search gradebook columns
• GradebookColumnAdminSession: a session to manage gradebook columns
• GradebookColumnDerivationSession: a session to manage derived gradebook columns
• GradebookColumnNotificationSession a session for subscribing to new or deleted gradebook columns
• GradebookColumnGradebookSession: a session for retrieving gradebook column to gradebook mappings
• GradebookColumnGradebookAssignmentSession: a session for managing gradebook column to gradebook mappings
• GradebookColumnSmartGradebookSession: a session for managing smart gradebooks of gradebook columns

• GradebookLookupSession: a session to lookup gradebooks
• GradebookQuerySession: a session to query gradebooks
• GradebookSearchSession : a session to search gradebooks
• GradebookAdminSession : a session to create, modify and delete gradebooks
• GradebookNotificationSession : a session to receive messages pertaining to gradebook changes
• GradebookHierarchySession: a session to traverse the gradebook hierarchy
• GradebookHierarchyDesignSession: a session to manage the gradebook hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
GradebookAdminSession	getGradebookAdminSession(Proxy proxy) Gets the OsidSession associated with the gradebook administration service.
GradebookColumnAdminSession	getGradebookColumnAdminSession(Proxy proxy) Gets the OsidSession associated with the gradebook column administration service.
GradebookColumnAdminSession	getGradebookColumnAdminSessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the gradebook column admin service for the given gradebook.
GradebookColumnGradebookAssignmentSession	getGradebookColumnGradebookAssignmentSession(Proxy proxy) Gets the session for assigning gradebook column to gradebook mappings.
GradebookColumnGradebookSession	getGradebookColumnGradebookSession(Proxy proxy) Gets the session for retrieving gradebook column to gradebook mappings.
GradebookColumnLookupSession	getGradebookColumnLookupSession(Proxy proxy) Gets the OsidSession associated with the gradebook column lookup service.
GradebookColumnLookupSession	getGradebookColumnLookupSessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the gradebook column lookup service for the given gradebook.
GradebookColumnNotificationSession	getGradebookColumnNotificationSession(GradebookColumnReceiver gradebookColumnReceiver, Proxy proxy) Gets the notification session for notifications pertaining to gradebook column changes.
GradebookColumnNotificationSession	getGradebookColumnNotificationSessionForGradebook(GradebookColumnReceiver gradebookColumnReceiver, Id gradebookId, Proxy proxy) Gets the OsidSession associated with the gradebook column notification service for the given gradebook.
GradebookColumnQuerySession	getGradebookColumnQuerySession(Proxy proxy) Gets the OsidSession associated with the gradebook column query service.
GradebookColumnQuerySession	getGradebookColumnQuerySessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the gradebook column query service for the given gradebook.
GradebookColumnSearchSession	getGradebookColumnSearchSession(Proxy proxy) Gets the OsidSession associated with the gradebook column search service.
GradebookColumnSearchSession	getGradebookColumnSearchSessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the gradebook column search service for the given gradebook.
GradebookColumnSmartGradebookSession	getGradebookColumnSmartGradebookSession(Id gradebookId, Proxy proxy) Gets the session for managing smart gradebooks of gradebook columns.
GradebookHierarchyDesignSession	getGradebookHierarchyDesignSession(Proxy proxy) Gets the session designing gradebook hierarchies.
GradebookHierarchySession	getGradebookHierarchySession(Proxy proxy) Gets the session traversing gradebook hierarchies.
GradebookLookupSession	getGradebookLookupSession(Proxy proxy) Gets the OsidSession associated with the gradebook lookup service.
GradebookNotificationSession	getGradebookNotificationSession(GradebookReceiver gradebookReceiver, Proxy proxy) Gets the notification session for notifications pertaining to gradebook service changes.
GradebookQuerySession	getGradebookQuerySession(Proxy proxy) Gets the OsidSession associated with the gradebook query service.
GradebookSearchSession	getGradebookSearchSession(Proxy proxy) Gets the OsidSession associated with the gradebook search service.
GradeEntryAdminSession	getGradeEntryAdminSession(Proxy proxy) Gets the OsidSession associated with the grade entry administration service.
GradeEntryAdminSession	getGradeEntryAdminSessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade entry admin service for the given gradebook.
GradeEntryLookupSession	getGradeEntryLookupSession(Proxy proxy) Gets the OsidSession associated with the grade entry lookup service.
GradeEntryLookupSession	getGradeEntryLookupSessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade entry lookup service for the given gradebook.
GradeEntryNotificationSession	getGradeEntryNotificationSession(GradeEntryReceiver gradeEntryReceiver, Proxy proxy) Gets the notification session for notifications pertaining to grade entry changes.
GradeEntryNotificationSession	getGradeEntryNotificationSessionForGradebook(GradeEntryReceiver gradeEntryReceiver, Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade entry notification service for the given gradebook.
GradeEntryQuerySession	getGradeEntryQuerySession(Proxy proxy) Gets the OsidSession associated with the grade entry query service.
GradeEntryQuerySession	getGradeEntryQuerySessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade entry query service for the given gradebook.
GradeEntrySearchSession	getGradeEntrySearchSession(Proxy proxy) Gets the OsidSession associated with the grade entry search service.
GradeEntrySearchSession	getGradeEntrySearchSessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade entry search service for the given gradebook.
GradeSystemAdminSession	getGradeSystemAdminSession(Proxy proxy) Gets the OsidSession associated with the grade system administration service.
GradeSystemAdminSession	getGradeSystemAdminSessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade system admin service for the given gradebook.
GradeSystemGradebookSession	getGradeSystemGradebookAssignmentSession(Proxy proxy) Gets the session for assigning grade system to gradebook mappings.
GradeSystemGradebookSession	getGradeSystemGradebookSession(Proxy proxy) Gets the session for retrieving grade system to gradebook mappings.
GradeSystemLookupSession	getGradeSystemLookupSession(Proxy proxy) Gets the OsidSession associated with the grade system lookup service.
GradeSystemLookupSession	getGradeSystemLookupSessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade system lookup service for the given gradebook.
GradeSystemNotificationSession	getGradeSystemNotificationSession(GradeSystemReceiver gradeSystemReceiver, Proxy proxy) Gets the notification session for notifications pertaining to grade system changes.
GradeSystemNotificationSession	getGradeSystemNotificationSessionForGradebook(GradeSystemReceiver gradeSystemReceiver, Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade system notification service for the given gradebook.
GradeSystemQuerySession	getGradeSystemQuerySession(Proxy proxy) Gets the OsidSession associated with the grade system query service.
GradeSystemQuerySession	getGradeSystemQuerySessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade system query service for the given gradebook.
GradeSystemSearchSession	getGradeSystemSearchSession(Proxy proxy) Gets the OsidSession associated with the grade system search service.
GradeSystemSearchSession	getGradeSystemSearchSessionForGradebook(Id gradebookId, Proxy proxy) Gets the OsidSession associated with the grade system search service for the given gradebook.
GradeSystemSmartGradebookSession	getGradeSystemSmartGradebookSession(Id gradebookId, Proxy proxy) Gets the session for managing smart gradebooks of grade systems.
GradingBatchProxyManager	getGradingBatchProxyManager() Gets the GradingBatchProxyManager.
GradingCalculationProxyManager	getGradingCalculationProxyManager() Gets the GradingCalculationProxyManager.
GradingTransformProxyManager	getGradingTransformProxyManager() Gets the GradingTransformProxyManager.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.grading.GradingProfile

getGradebookColumnRecordTypes, getGradebookColumnSearchRecordTypes, getGradebookColumnSummaryRecordTypes, getGradebookRecordTypes, getGradebookSearchRecordTypes, getGradeEntryRecordTypes, getGradeEntrySearchRecordTypes, getGradeRecordTypes, getGradeSystemRecordTypes, getGradeSystemSearchRecordTypes, supportsGradebookAdmin, supportsGradebookColumnAdmin, supportsGradebookColumnGradebook, supportsGradebookColumnGradebookAssignment, supportsGradebookColumnLookup, supportsGradebookColumnNotification, supportsGradebookColumnQuery, supportsGradebookColumnRecordType, supportsGradebookColumnSearch, supportsGradebookColumnSearchRecordType, supportsGradebookColumnSmartGradebook, supportsGradebookColumnSummaryRecordType, supportsGradebookHierarchy, supportsGradebookHierarchyDesign, supportsGradebookLookup, supportsGradebookNotification, supportsGradebookQuery, supportsGradebookRecordType, supportsGradebookSearch, supportsGradebookSearchRecordType, supportsGradeEntryAdmin, supportsGradeEntryLookup, supportsGradeEntryNotification, supportsGradeEntryQuery, supportsGradeEntryRecordType, supportsGradeEntrySearch, supportsGradeEntrySearchRecordType, supportsGradeRecordType, supportsGradeSystemAdmin, supportsGradeSystemGradebook, supportsGradeSystemGradebookAssignment, supportsGradeSystemLookup, supportsGradeSystemNotification, supportsGradeSystemQuery, supportsGradeSystemRecordType, supportsGradeSystemSearch, supportsGradeSystemSearchRecordType, supportsGradeSystemSmartGradebook, supportsGradingBatch, supportsGradingCalculation, supportsGradingTransform, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getGradeSystemLookupSession

GradeSystemLookupSession getGradeSystemLookupSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the grade system lookup service.

Parameters:

proxy - a proxy

Returns:

a GradeSystemLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemLookup() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemLookup() is true.

getGradeSystemLookupSessionForGradebook

GradeSystemLookupSession getGradeSystemLookupSessionForGradebook(Id gradebookId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the grade system lookup service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeSystemLookupSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemLookup() and supportsVisibleFederation() are true.

getGradeSystemQuerySession

GradeSystemQuerySession getGradeSystemQuerySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the grade system query service.

Parameters:

proxy - a proxy

Returns:

a GradeSystemQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemQuery() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemQuery() is true.

getGradeSystemQuerySessionForGradebook

GradeSystemQuerySession getGradeSystemQuerySessionForGradebook(Id gradebookId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the grade system query service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeSystemQuerySession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemQuery() and supportsVisibleFederation() are true.

getGradeSystemSearchSession

GradeSystemSearchSession getGradeSystemSearchSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the grade system search service.

Parameters:

proxy - a proxy

Returns:

a GradeSystemSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemSearch() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemSearch() is true.

getGradeSystemSearchSessionForGradebook

GradeSystemSearchSession getGradeSystemSearchSessionForGradebook(Id gradebookId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the grade system search service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeSystemSearchSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemSearch() and supportsVisibleFederation() are true.

getGradeSystemAdminSession

GradeSystemAdminSession getGradeSystemAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the grade system administration service.

Parameters:

proxy - a proxy

Returns:

a GradeSystemAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemAdmin() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemAdmin() is true.

getGradeSystemAdminSessionForGradebook

GradeSystemAdminSession getGradeSystemAdminSessionForGradebook(Id gradebookId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the grade system admin service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeSystemAdminSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemAdmin() and supportsVisibleFederation() are true.

getGradeSystemNotificationSession

GradeSystemNotificationSession getGradeSystemNotificationSession(GradeSystemReceiver gradeSystemReceiver,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the notification session for notifications pertaining to grade system changes.

Parameters:

gradeSystemReceiver - the grade system receiver

proxy - a proxy

Returns:

a GradeSystemNotificationSession

Throws:

NullArgumentException - gradeSystemReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemNotification() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemNotification() is true.

getGradeSystemNotificationSessionForGradebook

GradeSystemNotificationSession getGradeSystemNotificationSessionForGradebook(GradeSystemReceiver gradeSystemReceiver,
                                                                           Id gradebookId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets the OsidSession associated with the grade system notification service for the given gradebook.

Parameters:

gradeSystemReceiver - the grade system receiver

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeSystemNotificationSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradeSystemReceiver, gradebookId or porxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemNotification() and supportsVisibleFederation() are true.

getGradeSystemGradebookSession

GradeSystemGradebookSession getGradeSystemGradebookSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the session for retrieving grade system to gradebook mappings.

Parameters:

proxy - a proxy

Returns:

a GradeSystemGradebookSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemGradebook() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemGradebook() is true.

getGradeSystemGradebookAssignmentSession

GradeSystemGradebookSession getGradeSystemGradebookAssignmentSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the session for assigning grade system to gradebook mappings.

Parameters:

proxy - a proxy

Returns:

a GradeSystemGradebookAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemGradebookAssignment() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemGradebookAssignment() is true.

getGradeSystemSmartGradebookSession

GradeSystemSmartGradebookSession getGradeSystemSmartGradebookSession(Id gradebookId,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the session for managing smart gradebooks of grade systems.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeSystemSmartGradebookSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemSmartGradebook() is false

Compliance:

optional - This method must be implemented if supportsGradeSystemSmartGradebook() is true.

getGradeEntryLookupSession

GradeEntryLookupSession getGradeEntryLookupSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the grade entry lookup service.

Parameters:

proxy - a proxy

Returns:

a GradeEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryLookup() is false

Compliance:

optional - This method must be implemented if supportsGradeEntryLookup() is true.

getGradeEntryLookupSessionForGradebook

GradeEntryLookupSession getGradeEntryLookupSessionForGradebook(Id gradebookId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the grade entry lookup service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeEntryLookupSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeEntryLookup() and supportsVisibleFederation() are true.

getGradeEntryQuerySession

GradeEntryQuerySession getGradeEntryQuerySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the grade entry query service.

Parameters:

proxy - a proxy

Returns:

a GradeEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryLookup() is false

Compliance:

optional - This method must be implemented if supportsGradeEntryQuery() is true.

getGradeEntryQuerySessionForGradebook

GradeEntryQuerySession getGradeEntryQuerySessionForGradebook(Id gradebookId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the grade entry query service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeEntryQuerySession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeEntryQuery() and supportsVisibleFederation() are true.

getGradeEntrySearchSession

GradeEntrySearchSession getGradeEntrySearchSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the grade entry search service.

Parameters:

proxy - a proxy

Returns:

a GradeEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntrySearch() is false

Compliance:

optional - This method must be implemented if supportsGradeEntrySearch() is true.

getGradeEntrySearchSessionForGradebook

GradeEntrySearchSession getGradeEntrySearchSessionForGradebook(Id gradebookId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the grade entry search service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeEntrySearchSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntrySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeEntrySearch() and supportsVisibleFederation() are true.

getGradeEntryAdminSession

GradeEntryAdminSession getGradeEntryAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the grade entry administration service.

Parameters:

proxy - a proxy

Returns:

a GradeEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryAdmin() is false

Compliance:

optional - This method must be implemented if supportsGradeEntryAdmin() is true.

getGradeEntryAdminSessionForGradebook

GradeEntryAdminSession getGradeEntryAdminSessionForGradebook(Id gradebookId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the grade entry admin service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeEntryAdminSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeEntryAdmin() and supportsVisibleFederation() are true.

getGradeEntryNotificationSession

GradeEntryNotificationSession getGradeEntryNotificationSession(GradeEntryReceiver gradeEntryReceiver,
                                                             Proxy proxy)
                                                               throws OperationFailedException

Gets the notification session for notifications pertaining to grade entry changes.

Parameters:

gradeEntryReceiver - the grade entry receiver

proxy - a proxy

Returns:

a GradeEntryNotificationSession

Throws:

NullArgumentException - gradeEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryNotification() is false

Compliance:

optional - This method must be implemented if supportsGradeEntryNotification() is true.

getGradeEntryNotificationSessionForGradebook

GradeEntryNotificationSession getGradeEntryNotificationSessionForGradebook(GradeEntryReceiver gradeEntryReceiver,
                                                                         Id gradebookId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

Gets the OsidSession associated with the grade entry notification service for the given gradebook.

Parameters:

gradeEntryReceiver - the grade entry receiver

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeEntryNotificationSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradeEntryReceiver, gradebookId or porxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradeEntryNotification() and supportsVisibleFederation() are true.

getGradebookColumnLookupSession

GradebookColumnLookupSession getGradebookColumnLookupSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the gradebook column lookup service.

Parameters:

proxy - a proxy

Returns:

a GradebookColumnLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnLookup() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnLookup() is true.

getGradebookColumnLookupSessionForGradebook

GradebookColumnLookupSession getGradebookColumnLookupSessionForGradebook(Id gradebookId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with the gradebook column lookup service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradebookColumnLookupSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnLookup() and supportsVisibleFederation() are true.

getGradebookColumnQuerySession

GradebookColumnQuerySession getGradebookColumnQuerySession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the gradebook column query service.

Parameters:

proxy - a proxy

Returns:

a GradebookColumnQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnQuery() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnQuery() is true.

getGradebookColumnQuerySessionForGradebook

GradebookColumnQuerySession getGradebookColumnQuerySessionForGradebook(Id gradebookId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the gradebook column query service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradebookColumnQuerySession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnQuery() and supportsVisibleFederation() are true.

getGradebookColumnSearchSession

GradebookColumnSearchSession getGradebookColumnSearchSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the gradebook column search service.

Parameters:

proxy - a proxy

Returns:

a GradebookColumnSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnSearch() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnSearch() is true.

getGradebookColumnSearchSessionForGradebook

GradebookColumnSearchSession getGradebookColumnSearchSessionForGradebook(Id gradebookId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with the gradebook column search service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradebookColumnSearchSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnSearch() and supportsVisibleFederation() are true.

getGradebookColumnAdminSession

GradebookColumnAdminSession getGradebookColumnAdminSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the gradebook column administration service.

Parameters:

proxy - a proxy

Returns:

a GradebookColumnAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnAdmin() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnAdmin() is true.

getGradebookColumnAdminSessionForGradebook

GradebookColumnAdminSession getGradebookColumnAdminSessionForGradebook(Id gradebookId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the gradebook column admin service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradebookColumnAdminSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnAdmin() and supportsVisibleFederation() are true.

getGradebookColumnNotificationSession

GradebookColumnNotificationSession getGradebookColumnNotificationSession(GradebookColumnReceiver gradebookColumnReceiver,
                                                                       Proxy proxy)
                                                                         throws OperationFailedException

Gets the notification session for notifications pertaining to gradebook column changes.

Parameters:

gradebookColumnReceiver - the grade system receiver

proxy - a proxy

Returns:

a GradebookColumnNotificationSession

Throws:

NullArgumentException - gradebookColumnReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnNotification() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnNotification() is true.

getGradebookColumnNotificationSessionForGradebook

GradebookColumnNotificationSession getGradebookColumnNotificationSessionForGradebook(GradebookColumnReceiver gradebookColumnReceiver,
                                                                                   Id gradebookId,
                                                                                   Proxy proxy)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

Gets the OsidSession associated with the gradebook column notification service for the given gradebook.

Parameters:

gradebookColumnReceiver - the gradebook column receiver

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradebookColumnNotificationSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookColumnReceiver, gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnNotification() and supportsVisibleFederation() are true.

getGradebookColumnGradebookSession

GradebookColumnGradebookSession getGradebookColumnGradebookSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the session for retrieving gradebook column to gradebook mappings.

Parameters:

proxy - a proxy

Returns:

a GradebookColumnGradebookSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnGradebook() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnGradebook() is true.

getGradebookColumnGradebookAssignmentSession

GradebookColumnGradebookAssignmentSession getGradebookColumnGradebookAssignmentSession(Proxy proxy)
                                                                                       throws OperationFailedException

Gets the session for assigning gradebook column to gradebook mappings.

Parameters:

proxy - a proxy

Returns:

a GradebookColumnGradebookAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnGradebookAssignment() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnGradebookAssignment() is true.

getGradebookColumnSmartGradebookSession

GradebookColumnSmartGradebookSession getGradebookColumnSmartGradebookSession(Id gradebookId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets the session for managing smart gradebooks of gradebook columns.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradebookColumnSmartGradebookSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnSmartGradebook() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnSmartGradebook() is true.

getGradebookLookupSession

GradebookLookupSession getGradebookLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the gradebook lookup service.

Parameters:

proxy - a proxy

Returns:

a GradebookLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookLookup() is false

Compliance:

optional - This method must be implemented if supportsGradebookLookup() is true.

getGradebookQuerySession

GradebookQuerySession getGradebookQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the gradebook query service.

Parameters:

proxy - a proxy

Returns:

a GradebookQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookQuery() is false

Compliance:

optional - This method must be implemented if supportsGradebookQuery() is true.

getGradebookSearchSession

GradebookSearchSession getGradebookSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the gradebook search service.

Parameters:

proxy - a proxy

Returns:

a GradebookSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookSearch() is false

Compliance:

optional - This method must be implemented if supportsGradebookSearch() is true.

getGradebookAdminSession

GradebookAdminSession getGradebookAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the gradebook administration service.

Parameters:

proxy - a proxy

Returns:

a GradebookAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookAdmin() is false

Compliance:

optional - This method must be implemented if supportsGradebookAdmin() is true.

getGradebookNotificationSession

GradebookNotificationSession getGradebookNotificationSession(GradebookReceiver gradebookReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the notification session for notifications pertaining to gradebook service changes.

Parameters:

gradebookReceiver - the gradebook receiver

proxy - a proxy

Returns:

a GradebookNotificationSession

Throws:

NullArgumentException - gradebookReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookNotification() is false

Compliance:

optional - This method must be implemented if supportsGradebookNotification() is true.

getGradebookHierarchySession

GradebookHierarchySession getGradebookHierarchySession(Proxy proxy)
                                                       throws OperationFailedException

Gets the session traversing gradebook hierarchies.

Parameters:

proxy - a proxy

Returns:

a GradebookHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookHierarchy() is false

Compliance:

optional - This method must be implemented if supportsGradebookHierarchy() is true.

getGradebookHierarchyDesignSession

GradebookHierarchyDesignSession getGradebookHierarchyDesignSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the session designing gradebook hierarchies.

Parameters:

proxy - a proxy

Returns:

a GradebookHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsGradebookHierarchyDesign() is true.

getGradingBatchProxyManager

GradingBatchProxyManager getGradingBatchProxyManager()
                                                     throws OperationFailedException

Gets the GradingBatchProxyManager.

Returns:

a GradingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradingBatch() is false

Compliance:

optional - This method must be implemented if supportsGradingBatch() is true.

getGradingCalculationProxyManager

GradingCalculationProxyManager getGradingCalculationProxyManager()
                                                                 throws OperationFailedException

Gets the GradingCalculationProxyManager.

Returns:

a GradingCalculationProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradingCalculation() is false

Compliance:

optional - This method must be implemented if supportsGradingCalculation() is true.

getGradingTransformProxyManager

GradingTransformProxyManager getGradingTransformProxyManager()
                                                             throws OperationFailedException

Gets the GradingTransformProxyManager.

Returns:

a GradingTransformManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradingTransform() is false

Compliance:

optional - This method must be implemented if supportsGradingTransform() is true.