Interface GradingManager

All Superinterfaces:

AutoCloseable, Closeable, GradingProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface GradingManager
extends OsidManager, GradingProfile

The grading manager provides access to grading sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• GradeLookupSession : a session to retrieve grades
• GradeQuerySession : a session to query for grades
• GradeSearchSession : a session to search for grades
• GradeAdminSession : a session to create and delete grades
• GradeNotificationSession : a session to receive notifications pertaining to grade changes
• GradeGradebookSession : a session to look up grade gradebook mappings
• GradeGradebookAssignmentSession : a session to manage grade to gradebook mappings
• GradeSmartGradebookSession: a session to man age dynamic gradebooks of grades

• 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
• GradeEntryGradebookSession : a session for retrieving grade entry to gradebook mappings
• GradeEntryGradebookAssignmentSession : a session for managing grade entry to gradebook mappings
• GradeEntrySmartGradebookSession : a session for managing smart gradebooks of grade entries

• 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
• 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

Modifier and Type	Method	Description
GradeAdminSession	getGradeAdminSession()	Gets the OsidSession associated with the grade administration service.
GradeAdminSession	getGradeAdminSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade administration service for the given gradebook.
GradebookAdminSession	getGradebookAdminSession()	Gets the OsidSession associated with the gradebook administration service.
GradebookColumnAdminSession	getGradebookColumnAdminSession()	Gets the OsidSession associated with the gradebook column administration service.
GradebookColumnAdminSession	getGradebookColumnAdminSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the gradebook column admin service for the given gradebook.
GradebookColumnGradebookAssignmentSession	getGradebookColumnGradebookAssignmentSession()	Gets the session for assigning gradebook column to gradebook mappings.
GradebookColumnGradebookSession	getGradebookColumnGradebookSession()	Gets the session for retrieving gradebook column to gradebook mappings.
GradebookColumnLookupSession	getGradebookColumnLookupSession()	Gets the OsidSession associated with the gradebook column lookup service.
GradebookColumnLookupSession	getGradebookColumnLookupSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the gradebook column lookup service for the given gradebook.
GradebookColumnNotificationSession	getGradebookColumnNotificationSession(GradebookColumnReceiver gradebookColumnReceiver)	Gets the notification session for notifications pertaining to gradebook column changes.
GradebookColumnNotificationSession	getGradebookColumnNotificationSessionForGradebook(GradebookColumnReceiver gradebookColumnReceiver, Id gradebookId)	Gets the OsidSession associated with the gradebook column notification service for the given gradebook.
GradebookColumnQuerySession	getGradebookColumnQuerySession()	Gets the OsidSession associated with the gradebook column query service.
GradebookColumnQuerySession	getGradebookColumnQuerySessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the gradebook column query service for the given gradebook.
GradebookColumnSearchSession	getGradebookColumnSearchSession()	Gets the OsidSession associated with the gradebook column search service.
GradebookColumnSearchSession	getGradebookColumnSearchSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the gradebook column search service for the given gradebook.
GradebookColumnSmartGradebookSession	getGradebookColumnSmartGradebookSession(Id gradebookId)	Gets the session for managing smart gradebooks of gradebook columns.
GradebookHierarchyDesignSession	getGradebookHierarchyDesignSession()	Gets the session designing gradebook hierarchies.
GradebookHierarchySession	getGradebookHierarchySession()	Gets the session traversing gradebook hierarchies.
GradebookLookupSession	getGradebookLookupSession()	Gets the OsidSession associated with the gradebook lookup service.
GradebookNotificationSession	getGradebookNotificationSession(GradebookReceiver gradebookReceiver)	Gets the notification session for notifications pertaining to gradebook service changes.
GradebookQuerySession	getGradebookQuerySession()	Gets the OsidSession associated with the gradebook query service.
GradebookSearchSession	getGradebookSearchSession()	Gets the OsidSession associated with the gradebook search service.
GradeEntryAdminSession	getGradeEntryAdminSession()	Gets the OsidSession associated with the grade entry administration service.
GradeEntryAdminSession	getGradeEntryAdminSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade entry admin service for the given gradebook.
GradeEntryGradebookAssignmentSession	getGradeEntryGradebookAssignmentSession()	Gets the session for assigning grade entry to gradebook mappings.
GradeEntryGradebookSession	getGradeEntryGradebookSession()	Gets the session for retrieving grade entry to gradebook mappings.
GradeEntryLookupSession	getGradeEntryLookupSession()	Gets the OsidSession associated with the grade entry lookup service.
GradeEntryLookupSession	getGradeEntryLookupSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade entry lookup service for the given gradebook.
GradeEntryNotificationSession	getGradeEntryNotificationSession(GradeEntryReceiver receiver)	Gets the notification session for notifications pertaining to grade entry changes.
GradeEntryNotificationSession	getGradeEntryNotificationSessionForGradebook(GradeEntryReceiver receiver, Id gradebookId)	Gets the OsidSession associated with the grade entry notification service for the given gradebook.
GradeEntryQuerySession	getGradeEntryQuerySession()	Gets the OsidSession associated with the grade entry query service.
GradeEntryQuerySession	getGradeEntryQuerySessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade entry query service for the given gradebook.
GradeEntrySearchSession	getGradeEntrySearchSession()	Gets the OsidSession associated with the grade entry search service.
GradeEntrySearchSession	getGradeEntrySearchSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade entry search service for the given gradebook.
GradeEntrySmartGradebookSession	getGradeEntrySmartGradebookSession(Id gradebookId)	Gets the session for managing smart gradebooks of grade entries.
GradeGradebookAssignmentSession	getGradeGradebookAssignmentSession()	Gets the OsidSession associated with assigning grades to gradebooks.
GradeGradebookSession	getGradeGradebookSession()	Gets the OsidSession to lookup grade/gradebook mappings.
GradeLookupSession	getGradeLookupSession()	Gets the OsidSession associated with the grade lookup service.
GradeLookupSession	getGradeLookupSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade lookup service for the given gradebook.
GradeNotificationSession	getGradeNotificationSession(GradeReceiver gradeReceiver)	Gets the OsidSession associated with the grade notification service.
GradeNotificationSession	getGradeNotificationSessionForGradebook(GradeReceiver gradeReceiver, Id gradebookId)	Gets the OsidSession associated with the grade notification service for the given gradebook.
GradeQuerySession	getGradeQuerySession()	Gets the OsidSession associated with the grade query service.
GradeQuerySession	getGradeQuerySessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade query service for the given gradebook.
GradeSearchSession	getGradeSearchSession()	Gets the OsidSession associated with the grade search service.
GradeSearchSession	getGradeSearchSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade search service for the given gradebook.
GradeSmartGradebookSession	getGradeSmartGradebookSession(Id gradebookId)	Gets the OsidSession to manage grade smart gradebooks.
GradeSystemAdminSession	getGradeSystemAdminSession()	Gets the OsidSession associated with the grade system administration service.
GradeSystemAdminSession	getGradeSystemAdminSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade system admin service for the given gradebook.
GradeSystemGradebookAssignmentSession	getGradeSystemGradebookAssignmentSession()	Gets the session for assigning grade system to gradebook mappings.
GradeSystemGradebookSession	getGradeSystemGradebookSession()	Gets the session for retrieving grade system to gradebook mappings.
GradeSystemLookupSession	getGradeSystemLookupSession()	Gets the OsidSession associated with the grade system lookup service.
GradeSystemLookupSession	getGradeSystemLookupSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade system lookup service for the given gradebook.
GradeSystemNotificationSession	getGradeSystemNotificationSession(GradeSystemReceiver gradeSystemReceiver)	Gets the notification session for notifications pertaining to grade system changes.
GradeSystemNotificationSession	getGradeSystemNotificationSessionForGradebook(GradeSystemReceiver gradeSystemReceiver, Id gradebookId)	Gets the OsidSession associated with the grade system notification service for the given gradebook.
GradeSystemQuerySession	getGradeSystemQuerySession()	Gets the OsidSession associated with the grade system query service.
GradeSystemQuerySession	getGradeSystemQuerySessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade system query service for the given gradebook.
GradeSystemSearchSession	getGradeSystemSearchSession()	Gets the OsidSession associated with the grade system search service.
GradeSystemSearchSession	getGradeSystemSearchSessionForGradebook(Id gradebookId)	Gets the OsidSession associated with the grade system search service for the given gradebook.
GradeSystemSmartGradebookSession	getGradeSystemSmartGradebookSession(Id gradebookId)	Gets the session for managing smart gradebooks of grade systems.
GradingBatchManager	getGradingBatchManager()	Gets the GradingBatchManager .
GradingCalculationManager	getGradingCalculationManager()	Gets the GradingCalculationManager .
GradingTransformManager	getGradingTransformManager()	Gets the GradingTransformManager .

Methods inherited from interface Closeable

close

Methods inherited from interface GradingProfile

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

Modifier and Type	Method	Description
TypeList	getGradebookColumnRecordTypes()	Gets the supported GradebookColumn record types.
TypeList	getGradebookColumnSearchRecordTypes()	Gets the supported gradebook column search record types.
TypeList	getGradebookColumnSummaryRecordTypes()	Gets the supported GradebookColumnSummary record types.
TypeList	getGradebookRecordTypes()	Gets the supported Gradebook record types.
TypeList	getGradebookSearchRecordTypes()	Gets the supported gradebook search record types.
TypeList	getGradeEntryRecordTypes()	Gets the supported GradeEntry record types.
TypeList	getGradeEntrySearchRecordTypes()	Gets the supported GradeEntry search record types.
TypeList	getGradeRecordTypes()	Gets the supported Grade record types.
TypeList	getGradeSearchRecordTypes()	Gets the supported Grade search types.
TypeList	getGradeSystemRecordTypes()	Gets the supported GradeSystem record types.
TypeList	getGradeSystemSearchRecordTypes()	Gets the supported GradeSystem search record types.
boolean	supportsGradeAdmin()	Tests if a grade administrative service is supported.
boolean	supportsGradebookAdmin()	Tests if a gradebook administrative service is supported.
boolean	supportsGradebookColumnAdmin()	Tests if a gradebook column administrative service is supported.
boolean	supportsGradebookColumnGradebook()	Tests if a gradebook column to gradebook lookup session is available.
boolean	supportsGradebookColumnGradebookAssignment()	Tests if a gradebook column to gradebook assignment session is available.
boolean	supportsGradebookColumnLookup()	Tests if a gradebook column lookup service is supported.
boolean	supportsGradebookColumnNotification()	Tests if gradebook column notification is supported.
boolean	supportsGradebookColumnQuery()	Tests if a gradebook column query service is supported.
boolean	supportsGradebookColumnRecordType(Type gradebookColumnRecordType)	Tests if the given GradebookColumn record type is supported.
boolean	supportsGradebookColumnSearch()	Tests if a gradebook column search service is supported.
boolean	supportsGradebookColumnSearchRecordType(Type gradebookColumnSearchRecordType)	Tests if the given gradebook column search record type is supported.
boolean	supportsGradebookColumnSmartGradebook()	Tests if a gradebook column smart gradebookt session is available.
boolean	supportsGradebookColumnSummaryRecordType(Type gradebookColumnSummaryRecordType)	Tests if the given GradebookColumnSummary record type is supported.
boolean	supportsGradebookHierarchy()	Tests if a gradebook hierarchy traversal is supported.
boolean	supportsGradebookHierarchyDesign()	Tests if gradebook hierarchy design is supported.
boolean	supportsGradebookLookup()	Tests if a gradebook lookup service is supported.
boolean	supportsGradebookNotification()	Tests if gradebook notification is supported.
boolean	supportsGradebookQuery()	Tests if a gradebook query service is supported.
boolean	supportsGradebookRecordType(Type gradebookRecordType)	Tests if the given Gradebook record type is supported.
boolean	supportsGradebookSearch()	Tests if a gradebook search service is supported.
boolean	supportsGradebookSearchRecordType(Type gradebookSearchRecordType)	Tests if the given gradebook search record type is supported.
boolean	supportsGradeEntryAdmin()	Tests if a grade entry administrative service is supported.
boolean	supportsGradeEntryGradebook()	Tests if a grade entry to gradebook lookup session is available.
boolean	supportsGradeEntryGradebookAssignment()	Tests if a grade entry to gradebook assignment session is available.
boolean	supportsGradeEntryLookup()	Tests if a grade entry lookup service is supported.
boolean	supportsGradeEntryNotification()	Tests if grade entry notification is supported.
boolean	supportsGradeEntryQuery()	Tests if a grade entry query service is supported.
boolean	supportsGradeEntryRecordType(Type gradeEntryRecordType)	Tests if the given GradeEntry record type is supported.
boolean	supportsGradeEntrySearch()	Tests if a grade entry search service is supported.
boolean	supportsGradeEntrySearchRecordType(Type gradeEntrySearchRecordType)	Tests if the given GradeEntry search record type is supported.
boolean	supportsGradeEntrySmartGradebook()	Tests if a grade entry smart gradebook session is available.
boolean	supportsGradeGradebook()	Tests if a grade gradebook lookup service is supported.
boolean	supportsGradeGradebookAssignment()	Tests if a grade gradebook assignment service is supported.
boolean	supportsGradeLookup()	Tests if looking up grades is supported.
boolean	supportsGradeNotification()	Tests if a grade notification service is supported.
boolean	supportsGradeQuery()	Tests if querying grades is supported.
boolean	supportsGradeRecordType(Type gradeRecordType)	Tests if the given Grade record type is supported.
boolean	supportsGradeSearch()	Tests if searching grades is supported.
boolean	supportsGradeSearchRecordType(Type gradeSearchRecordType)	Tests if the given Grade search type is supported.
boolean	supportsGradeSmartGradebook()	Tests if a grade smart gradebook service is supported.
boolean	supportsGradeSystemAdmin()	Tests if a grade system administrative service is supported.
boolean	supportsGradeSystemGradebook()	Tests if a grade system to gradebook lookup session is available.
boolean	supportsGradeSystemGradebookAssignment()	Tests if a grade system to gradebook assignment session is available.
boolean	supportsGradeSystemLookup()	Tests if a grade system lookup service is supported.
boolean	supportsGradeSystemNotification()	Tests if grade system notification is supported.
boolean	supportsGradeSystemQuery()	Tests if a grade system query service is supported.
boolean	supportsGradeSystemRecordType(Type gradeSystemRecordType)	Tests if the given GradeSystem record type is supported.
boolean	supportsGradeSystemSearch()	Tests if a grade system search service is supported.
boolean	supportsGradeSystemSearchRecordType(Type gradeSystemSearchRecordType)	Tests if the given GradeSystem search record type is supported.
boolean	supportsGradeSystemSmartGradebook()	Tests if a grade system smart gradebook session is available.
boolean	supportsGradingBatch()	Tests if a grading batch service is supported.
boolean	supportsGradingCalculation()	Tests if a grading calculation service is supported.
boolean	supportsGradingTransform()	Tests if a grade system transform service is supported.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getGradeLookupSession

GradeLookupSession getGradeLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the grade lookup service.

Returns:

a GradeLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeLookup()} is {@code true} .

getGradeLookupSessionForGradebook

GradeLookupSession getGradeLookupSessionForGradebook(Id gradebookId)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the Gradebook

Returns:

a GradeLookupSession

Throws:

NotFoundException - no Gradebook found by the given Id

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeLookup()} and {@code supportsVisibleFederation()} are {@code true}

getGradeQuerySession

GradeQuerySession getGradeQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the grade query service.

Returns:

a GradeQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeQuery()} is {@code true} .

getGradeQuerySessionForGradebook

GradeQuerySession getGradeQuerySessionForGradebook(Id gradebookId)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the Gradebook

Returns:

a GradeQuerySession

Throws:

NotFoundException - no gradebook found by the given Id

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeQuery()} and {@code supportsVisibleFederation()} are {@code true}

getGradeSearchSession

GradeSearchSession getGradeSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the grade search service.

Returns:

a GradeSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSearch()} is {@code true} .

getGradeSearchSessionForGradebook

GradeSearchSession getGradeSearchSessionForGradebook(Id gradebookId)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the Gradebook

Returns:

a GradeSearchSession

Throws:

NotFoundException - no gradebook found by the given Id

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSearch()} and {@code supportsVisibleFederation()} are {@code true}

getGradeAdminSession

GradeAdminSession getGradeAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the grade administration service.

Returns:

a GradeAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeAdmin()} is {@code true} .

getGradeAdminSessionForGradebook

GradeAdminSession getGradeAdminSessionForGradebook(Id gradebookId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the grade administration service for the given gradebook.

Parameters:

gradebookId - the Id of the Gradebook

Returns:

a GradeAdminSession

Throws:

NotFoundException - no gradebook found by the given Id

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getGradeNotificationSession

GradeNotificationSession getGradeNotificationSession(GradeReceiver gradeReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the grade notification service.

Parameters:

gradeReceiver - the notification callback

Returns:

a GradeNotificationSession

Throws:

NullArgumentException - gradeReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeNotification()} is {@code true} .

getGradeNotificationSessionForGradebook

GradeNotificationSession getGradeNotificationSessionForGradebook(GradeReceiver gradeReceiver,
 Id gradebookId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

gradeReceiver - the notification callback

gradebookId - the Id of the Gradebook

Returns:

a GradeNotificationSession

Throws:

NotFoundException - no gradebook found by the given Id

NullArgumentException - gradeReceiver or gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeNotification()} and {@code supportsVisibleFederation()} are {@code true}

getGradeGradebookSession

GradeGradebookSession getGradeGradebookSession()
                                        throws OperationFailedException

Gets the OsidSession to lookup grade/gradebook mappings.

Returns:

a GradeGradebookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeGradebook() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeGradebook()} is {@code true} .

getGradeGradebookAssignmentSession

GradeGradebookAssignmentSession getGradeGradebookAssignmentSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with assigning grades to gradebooks.

Returns:

a GradeGradebookAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeGradebookAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeGradebookAssignment()} is {@code true} .

getGradeSmartGradebookSession

GradeSmartGradebookSession getGradeSmartGradebookSession(Id gradebookId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage grade smart gradebooks.

Parameters:

gradebookId - the Id of the Gradebook

Returns:

a GradeSmartGradebookSession

Throws:

NotFoundException - no gradebook found by the given Id

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSmartGradebook() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSmartGradebook()} is {@code true} .

getGradeSystemLookupSession

GradeSystemLookupSession getGradeSystemLookupSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the grade system lookup service.

Returns:

a GradeSystemLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSystemLookup()} is {@code true} .

getGradeSystemLookupSessionForGradebook

GradeSystemLookupSession getGradeSystemLookupSessionForGradebook(Id gradebookId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeSystemLookupSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemLookup() or supportsVisibleFederation() is false

Compliance:

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

getGradeSystemQuerySession

GradeSystemQuerySession getGradeSystemQuerySession()
                                            throws OperationFailedException

Gets the OsidSession associated with the grade system query service.

Returns:

a GradeSystemQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSystemQuery()} is {@code true} .

getGradeSystemQuerySessionForGradebook

GradeSystemQuerySession getGradeSystemQuerySessionForGradebook(Id gradebookId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeSystemQuerySession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemQuery() or supportsVisibleFederation() is false

Compliance:

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

getGradeSystemSearchSession

GradeSystemSearchSession getGradeSystemSearchSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the grade system search service.

Returns:

a GradeSystemSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSystemSearch()} is {@code true} .

getGradeSystemSearchSessionForGradebook

GradeSystemSearchSession getGradeSystemSearchSessionForGradebook(Id gradebookId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeSystemSearchSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemSearch() or supportsVisibleFederation() is false

Compliance:

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

getGradeSystemAdminSession

GradeSystemAdminSession getGradeSystemAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the grade system administration service.

Returns:

a GradeSystemAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSystemAdmin()} is {@code true} .

getGradeSystemAdminSessionForGradebook

GradeSystemAdminSession getGradeSystemAdminSessionForGradebook(Id gradebookId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeSystemAdminSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemAdmin() or supportsVisibleFederation() is false

Compliance:

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

getGradeSystemNotificationSession

GradeSystemNotificationSession getGradeSystemNotificationSession(GradeSystemReceiver gradeSystemReceiver)
                                                          throws OperationFailedException

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

Parameters:

gradeSystemReceiver - the grade system receiver

Returns:

a GradeSystemNotificationSession

Throws:

NullArgumentException - gradeSystemReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSystemNotification()} is {@code true} .

getGradeSystemNotificationSessionForGradebook

GradeSystemNotificationSession getGradeSystemNotificationSessionForGradebook(GradeSystemReceiver gradeSystemReceiver,
 Id gradebookId)
                                                                      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

Returns:

a GradeSystemNotificationSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradeSystemReceiver or gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemNotification() or supportsVisibleFederation() is false

Compliance:

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

getGradeSystemGradebookSession

GradeSystemGradebookSession getGradeSystemGradebookSession()
                                                    throws OperationFailedException

Gets the session for retrieving grade system to gradebook mappings.

Returns:

a GradeSystemGradebookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemGradebook() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSystemGradebook()} is {@code true} .

getGradeSystemGradebookAssignmentSession

GradeSystemGradebookAssignmentSession getGradeSystemGradebookAssignmentSession()
                                                                        throws OperationFailedException

Gets the session for assigning grade system to gradebook mappings.

Returns:

a GradeSystemGradebookAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemGradebookAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSystemGradebookAssignment()} is {@code true} .

getGradeSystemSmartGradebookSession

GradeSystemSmartGradebookSession getGradeSystemSmartGradebookSession(Id gradebookId)
                                                              throws NotFoundException,
OperationFailedException

Gets the session for managing smart gradebooks of grade systems.

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeSystemSmartGradebookSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemSmartGradebook() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeSystemSmartGradebook()} is {@code true} .

getGradeEntryLookupSession

GradeEntryLookupSession getGradeEntryLookupSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the grade entry lookup service.

Returns:

a GradeEntryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeEntryLookup()} is {@code true} .

getGradeEntryLookupSessionForGradebook

GradeEntryLookupSession getGradeEntryLookupSessionForGradebook(Id gradebookId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeEntryLookupSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getGradeEntryQuerySession

GradeEntryQuerySession getGradeEntryQuerySession()
                                          throws OperationFailedException

Gets the OsidSession associated with the grade entry query service.

Returns:

a GradeEntryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeEntryQuery()} is {@code true} .

getGradeEntryQuerySessionForGradebook

GradeEntryQuerySession getGradeEntryQuerySessionForGradebook(Id gradebookId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeEntryQuerySession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getGradeEntrySearchSession

GradeEntrySearchSession getGradeEntrySearchSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the grade entry search service.

Returns:

a GradeEntrySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntrySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeEntrySearch()} is {@code true} .

getGradeEntrySearchSessionForGradebook

GradeEntrySearchSession getGradeEntrySearchSessionForGradebook(Id gradebookId)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeEntrySearchSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getGradeEntryAdminSession

GradeEntryAdminSession getGradeEntryAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the grade entry administration service.

Returns:

a GradeEntryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeEntryAdmin()} is {@code true} .

getGradeEntryAdminSessionForGradebook

GradeEntryAdminSession getGradeEntryAdminSessionForGradebook(Id gradebookId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeEntryAdminSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getGradeEntryNotificationSession

GradeEntryNotificationSession getGradeEntryNotificationSession(GradeEntryReceiver receiver)
                                                        throws OperationFailedException

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

Parameters:

receiver - the grade entry receiver

Returns:

a GradeEntryNotificationSession

Throws:

NullArgumentException - receiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeEntryNotification()} is {@code true} .

getGradeEntryNotificationSessionForGradebook

GradeEntryNotificationSession getGradeEntryNotificationSessionForGradebook(GradeEntryReceiver receiver,
 Id gradebookId)
                                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

receiver - the grade entry receiver

gradebookId - the Id of the gradebook

Returns:

a GradeEntryNotificationSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - receiver or gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getGradeEntryGradebookSession

GradeEntryGradebookSession getGradeEntryGradebookSession()
                                                  throws OperationFailedException

Gets the session for retrieving grade entry to gradebook mappings.

Returns:

a GradeEntryGradebookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryGradebook() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeEntryGradebook()} is {@code true} .

getGradeEntryGradebookAssignmentSession

GradeEntryGradebookAssignmentSession getGradeEntryGradebookAssignmentSession()
                                                                      throws OperationFailedException

Gets the session for assigning grade entry to gradebook mappings.

Returns:

a GradeEntryGradebookAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryGradebookAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeEntryGradebookAssignment()} is {@code true} .

getGradeEntrySmartGradebookSession

GradeEntrySmartGradebookSession getGradeEntrySmartGradebookSession(Id gradebookId)
                                                            throws NotFoundException,
OperationFailedException

Gets the session for managing smart gradebooks of grade entries.

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradeEntrySmartGradebookSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntrySmartGradebook() is false

Compliance:

optional - This method must be implemented if {@code supportsGradeEntrySmartGradebook()} is {@code true} .

getGradebookColumnLookupSession

GradebookColumnLookupSession getGradebookColumnLookupSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the gradebook column lookup service.

Returns:

a GradebookColumnLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookColumnLookup()} is {@code true} .

getGradebookColumnLookupSessionForGradebook

GradebookColumnLookupSession getGradebookColumnLookupSessionForGradebook(Id gradebookId)
                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradebookColumnLookupSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnLookup() or supportsVisibleFederation() is false

Compliance:

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

getGradebookColumnQuerySession

GradebookColumnQuerySession getGradebookColumnQuerySession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the gradebook column query service.

Returns:

a GradebookColumnQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookColumnQuery()} is {@code true} .

getGradebookColumnQuerySessionForGradebook

GradebookColumnQuerySession getGradebookColumnQuerySessionForGradebook(Id gradebookId)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradebookColumnQuerySession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnQuery() or supportsVisibleFederation() is false

Compliance:

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

getGradebookColumnSearchSession

GradebookColumnSearchSession getGradebookColumnSearchSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the gradebook column search service.

Returns:

a GradebookColumnSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookColumnSearch()} is {@code true} .

getGradebookColumnSearchSessionForGradebook

GradebookColumnSearchSession getGradebookColumnSearchSessionForGradebook(Id gradebookId)
                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradebookColumnSearchSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnSearch() or supportsVisibleFederation() is false

Compliance:

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

getGradebookColumnAdminSession

GradebookColumnAdminSession getGradebookColumnAdminSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the gradebook column administration service.

Returns:

a GradebookColumnAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookColumnAdmin()} is {@code true} .

getGradebookColumnAdminSessionForGradebook

GradebookColumnAdminSession getGradebookColumnAdminSessionForGradebook(Id gradebookId)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradebookColumnAdminSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnAdmin() or supportsVisibleFederation() is false

Compliance:

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

getGradebookColumnNotificationSession

GradebookColumnNotificationSession getGradebookColumnNotificationSession(GradebookColumnReceiver gradebookColumnReceiver)
                                                                  throws OperationFailedException

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

Parameters:

gradebookColumnReceiver - the gradebook column receiver

Returns:

a GradebookColumnNotificationSession

Throws:

NullArgumentException - gradebookColumnReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookColumnNotification()} is {@code true} .

getGradebookColumnNotificationSessionForGradebook

GradebookColumnNotificationSession getGradebookColumnNotificationSessionForGradebook(GradebookColumnReceiver gradebookColumnReceiver,
 Id gradebookId)
                                                                              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

Returns:

a GradebookColumnNotificationSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookColumnReceiver or gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnNotification() or supportsVisibleFederation() is false

Compliance:

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

getGradebookColumnGradebookSession

GradebookColumnGradebookSession getGradebookColumnGradebookSession()
                                                            throws OperationFailedException

Gets the session for retrieving gradebook column to gradebook mappings.

Returns:

a GradebookColumnGradebookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnGradebook() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookColumnGradebook()} is {@code true} .

getGradebookColumnGradebookAssignmentSession

GradebookColumnGradebookAssignmentSession getGradebookColumnGradebookAssignmentSession()
                                                                                throws OperationFailedException

Gets the session for assigning gradebook column to gradebook mappings.

Returns:

a GradebookColumnGradebookAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnGradebookAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookColumnGradebookAssignment()} is {@code true} .

getGradebookColumnSmartGradebookSession

GradebookColumnSmartGradebookSession getGradebookColumnSmartGradebookSession(Id gradebookId)
                                                                      throws NotFoundException,
OperationFailedException

Gets the session for managing smart gradebooks of gradebook columns.

Parameters:

gradebookId - the Id of the gradebook

Returns:

a GradebookColumnSmartGradebookSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnSmartGradebook() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookColumnSmartGradebook()} is {@code true} .

getGradebookLookupSession

GradebookLookupSession getGradebookLookupSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the gradebook lookup service.

Returns:

a GradebookLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookLookup()} is true.

getGradebookQuerySession

GradebookQuerySession getGradebookQuerySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the gradebook query service.

Returns:

a GradebookQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookQuery()} is true.

getGradebookSearchSession

GradebookSearchSession getGradebookSearchSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the gradebook search service.

Returns:

a GradebookSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookSearch()} is true.

getGradebookAdminSession

GradebookAdminSession getGradebookAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the gradebook administration service.

Returns:

a GradebookAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookAdmin()} is true.

getGradebookNotificationSession

GradebookNotificationSession getGradebookNotificationSession(GradebookReceiver gradebookReceiver)
                                                      throws OperationFailedException

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

Parameters:

gradebookReceiver - the gradebook receiver

Returns:

a GradebookNotificationSession

Throws:

NullArgumentException - gradebookReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookNotification()} is true.

getGradebookHierarchySession

GradebookHierarchySession getGradebookHierarchySession()
                                                throws OperationFailedException

Gets the session traversing gradebook hierarchies.

Returns:

a GradebookHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookHierarchy()} is true.

getGradebookHierarchyDesignSession

GradebookHierarchyDesignSession getGradebookHierarchyDesignSession()
                                                            throws OperationFailedException

Gets the session designing gradebook hierarchies.

Returns:

a GradebookHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookHierarchyDesign()} is true.

getGradingBatchManager

GradingBatchManager getGradingBatchManager()
                                    throws OperationFailedException

Gets the GradingBatchManager .

Returns:

a GradingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsGradingBatch()} is true.

getGradingCalculationManager

GradingCalculationManager getGradingCalculationManager()
                                                throws OperationFailedException

Gets the GradingCalculationManager .

Returns:

a GradingCalculationManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradingCalculation() is false

Compliance:

optional - This method must be implemented if {@code supportsGradingCalculation()} is true.

getGradingTransformManager

GradingTransformManager getGradingTransformManager()
                                            throws OperationFailedException

Gets the GradingTransformManager .

Returns:

a GradingTransformManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsGradingTransform() is false

Compliance:

optional - This method must be implemented if {@code supportsGradingTransform()} is true.