Interface GradingCalculationProxyManager

All Superinterfaces:

AutoCloseable, Closeable, GradingCalculationProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface GradingCalculationProxyManager
extends OsidProxyManager, GradingCalculationProfile

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

• GradebookColumnCalculationLookupSession : a session to retrieve gradebook column calculations
• GradebookColumnCalculationAdminSession : a session to manage gradebook column calculations

Method Summary

Modifier and Type	Method	Description
GradebookColumnCalculationAdminSession	getGradebookColumnCalculationAdminSession(Proxy proxy)	Gets the OsidSession associated with the gradebook column calculation administrative service.
GradebookColumnCalculationAdminSession	getGradebookColumnCalculationAdminSessionForGradebook(Id gradebookId, Proxy proxy)	Gets the OsidSession associated with the gradebook column calculation administrative service for the given gradebook.
GradebookColumnCalculationLookupSession	getGradebookColumnCalculationLookupSession(Proxy proxy)	Gets the OsidSession associated with the gradebook column calculation lookup service.
GradebookColumnCalculationLookupSession	getGradebookColumnCalculationLookupSessionForGradebook(Id gradebookId, Proxy proxy)	Gets the OsidSession associated with the gradebook column calculation lookup service for the given gradebook.

Methods inherited from interface Closeable

close

Methods inherited from interface GradingCalculationProfile

getGradebookColumnCalculationRecordTypes, supportsGradebookColumnCalculationAdmin, supportsGradebookColumnCalculationLookup, supportsGradebookColumnCalculationRecordType, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getGradebookColumnCalculationRecordTypes()	Gets the supported GradebookColumnCalculation record types.
boolean	supportsGradebookColumnCalculationAdmin()	Tests if a gradebook column calculation administrative service is supported.
boolean	supportsGradebookColumnCalculationLookup()	Tests if a gradebook column calculation lookup service is supported.
boolean	supportsGradebookColumnCalculationRecordType(Type gradebookColumnCalculationRecordType)	Tests if the given GradebookColumnCalculation record type is supported.
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

getGradebookColumnCalculationLookupSession

GradebookColumnCalculationLookupSession getGradebookColumnCalculationLookupSession(Proxy proxy)
                                                                            throws OperationFailedException

Gets the OsidSession associated with the gradebook column calculation lookup service.

Parameters:

proxy - a proxy

Returns:

a GradebookColumnCalculationLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnLookup() is false

Compliance:

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

getGradebookColumnCalculationLookupSessionForGradebook

GradebookColumnCalculationLookupSession getGradebookColumnCalculationLookupSessionForGradebook(Id gradebookId,
 Proxy proxy)
                                                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradebookColumnCalculationLookupSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnCalculationLookup() or supportsVisibleFederation() is false

Compliance:

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

getGradebookColumnCalculationAdminSession

GradebookColumnCalculationAdminSession getGradebookColumnCalculationAdminSession(Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with the gradebook column calculation administrative service.

Parameters:

proxy - a proxy

Returns:

a GradebookColumnCalculationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnAdmin() is false

Compliance:

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

getGradebookColumnCalculationAdminSessionForGradebook

GradebookColumnCalculationAdminSession getGradebookColumnCalculationAdminSessionForGradebook(Id gradebookId,
 Proxy proxy)
                                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the gradebook column calculation administrative service for the given gradebook.

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradebookColumnCalculationAdminSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradebookColumnCalculationAdmin() or supportsVisibleFederation() is false

Compliance:

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