Interface GradingBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, GradingBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface GradingBatchProxyManager
extends OsidProxyManager, GradingBatchProfile

The grading batch proxy manager provides access to grading batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• GradeBatchAdminSession : a session to create, modify and delete grades in bulk
• GradeSystemBatchAdminSession : a session to create, modify and delete grade systems in bulk
• GradeEntryBatchSession : a session to create, modify and delete grade entries in bulk
• GradebookColumnBatchAdminSession : a session to create, modify and delete gradebook columns in bulk
• GradebookBatchAdminSession : a session to create, modify and delete gradebooks in bulk

Method Summary

Modifier and Type	Method	Description
GradeBatchAdminSession	getGradeBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk grade administration service.
GradeBatchAdminSession	getGradeBatchAdminSessionForGradebook(Id gradebookId, Proxy proxy)	Gets the OsidSession associated with the bulk grade administration service for the given gradebook.
GradebookBatchAdminSession	getGradebookBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk gradebook administration service.
GradebookColumnBatchAdminSession	getGradebookColumnBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk gradebook columnadministration service.
GradebookColumnBatchAdminSession	getGradebookColumnBatchAdminSessionForGradebook(Id gradebookId, Proxy proxy)	Gets the OsidSession associated with the bulk gradebook columnadministration service for the given gradebook.
GradeEntryBatchAdminSession	getGradeEntryBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk grade entry administration service.
GradeEntryBatchAdminSession	getGradeEntryBatchAdminSessionForGradebook(Id gradebookId, Proxy proxy)	Gets the OsidSession associated with the bulk grade entry administration service for the given gradebook.
GradeSystemBatchAdminSession	getGradeSystemBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk grade system administration service.
GradeSystemBatchAdminSession	getGradeSystemBatchAdminSessionForGradebook(Id gradebookId, Proxy proxy)	Gets the OsidSession associated with the bulk grade system administration service for the given gradebook.

Methods inherited from interface Closeable

close

Methods inherited from interface GradingBatchProfile

supportsGradeBatchAdmin, supportsGradebookBatchAdmin, supportsGradebookColumnBatchAdmin, supportsGradeEntryBatchAdmin, supportsGradeSystemBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsGradeBatchAdmin()	Tests if bulk administration of grades is available.
boolean	supportsGradebookBatchAdmin()	Tests if bulk administration of gradebooks is available.
boolean	supportsGradebookColumnBatchAdmin()	Tests if bulk administration of gradebook columns is available.
boolean	supportsGradeEntryBatchAdmin()	Tests if bulk administration of grade entries is available.
boolean	supportsGradeSystemBatchAdmin()	Tests if bulk administration of grade systems is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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

getGradeBatchAdminSession

GradeBatchAdminSession getGradeBatchAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk grade administration service.

Parameters:

proxy - a proxy

Returns:

a GradeBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeBatchAdmin() is false

Compliance:

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

getGradeBatchAdminSessionForGradebook

GradeBatchAdminSession getGradeBatchAdminSessionForGradebook(Id gradebookId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the Gradebook

proxy - a proxy

Returns:

a GradeBatchAdminSession

Throws:

NotFoundException - no Gradebook found by the given Id

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getGradeSystemBatchAdminSession

GradeSystemBatchAdminSession getGradeSystemBatchAdminSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the bulk grade system administration service.

Parameters:

proxy - a proxy

Returns:

a GradeSystemBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemBatchAdmin() is false

Compliance:

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

getGradeSystemBatchAdminSessionForGradebook

GradeSystemBatchAdminSession getGradeSystemBatchAdminSessionForGradebook(Id gradebookId,
 Proxy proxy)
                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the Gradebook

proxy - a proxy

Returns:

a GradeSystemBatchAdminSession

Throws:

NotFoundException - no Gradebook found by the given Id

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getGradeEntryBatchAdminSession

GradeEntryBatchAdminSession getGradeEntryBatchAdminSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the bulk grade entry administration service.

Parameters:

proxy - a proxy

Returns:

a GradeEntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryBatchAdmin() is false

Compliance:

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

getGradeEntryBatchAdminSessionForGradebook

GradeEntryBatchAdminSession getGradeEntryBatchAdminSessionForGradebook(Id gradebookId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the Gradebook

proxy - a proxy

Returns:

a GradeEntryBatchAdminSession

Throws:

NotFoundException - no Gradebook found by the given Id

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getGradebookColumnBatchAdminSession

GradebookColumnBatchAdminSession getGradebookColumnBatchAdminSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the bulk gradebook columnadministration service.

Parameters:

proxy - a proxy

Returns:

a GradebookColumnBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnBatchAdmin() is false

Compliance:

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

getGradebookColumnBatchAdminSessionForGradebook

GradebookColumnBatchAdminSession getGradebookColumnBatchAdminSessionForGradebook(Id gradebookId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk gradebook columnadministration service for the given gradebook.

Parameters:

gradebookId - the Id of the Gradebook

proxy - a proxy

Returns:

a GradebookColumnBatchAdminSession

Throws:

NotFoundException - no Gradebook found by the given Id

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getGradebookBatchAdminSession

GradebookBatchAdminSession getGradebookBatchAdminSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk gradebook administration service.

Parameters:

proxy - a proxy

Returns:

a GradebookBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookBatchAdmin() is false

Compliance:

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