Interface GradingTransformProxyManager

All Superinterfaces:

AutoCloseable, Closeable, GradingTransformProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface GradingTransformProxyManager
extends OsidProxyManager, GradingTransformProfile

The grading transform manager provides access to grading transform 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:

• GradeSystemTransformationSession : a session to convert grades among grade systems
• GradeSystemTransformLookupSession : a session to examine grade system transformation rules
• GradeSystemTransformAdminSession : a session to manage grade system transformation rules
• GradeSystemTransformNotiicationSession : a session to subscribe to grade system transformation notifications

Method Summary

Modifier and Type	Method	Description
GradeSystemTransformAdminSession	getGradeSystemTransformAdminSession(Proxy proxy)	Gets the OsidSession associated with the grade system transform admin service.
GradeSystemTransformAdminSession	getGradeSystemTransformAdminSessionForGradebook(Id gradebookId, Proxy proxy)	Gets the OsidSession associated with the grade system transform admin service for the given gradebook.
GradeSystemTransformationSession	getGradeSystemTransformationSession(Id sourceGradeSystemId, Id targetGradeSystemId, Proxy proxy)	Gets the session for transforming grades among grade systems.
GradeSystemTransformLookupSession	getGradeSystemTransformLookupSession(Proxy proxy)	Gets the OsidSession associated with the grade system transform lookup service.
GradeSystemTransformLookupSession	getGradeSystemTransformLookupSessionForGradebook(Id gradebookId, Proxy proxy)	Gets the OsidSession associated with the grade system transform lookup service for the given gradebook.
GradeSystemTransformNotificationSession	getGradeSystemTransformNotificationSession(GradeSystemTransformReceiver gradeSystemTransformReceiver, Proxy proxy)	Gets the notification session for notifications pertaining to grade system transform changes.
GradeSystemTransformNotificationSession	getGradeSystemTransformNotificationSessionForGradebook(GradeSystemTransformReceiver gradeSystemTransformReceiver, Id gradebookId, Proxy proxy)	Gets the OsidSession associated with the grade system transform notification service for the given gradebook.

Methods inherited from interface Closeable

close

Methods inherited from interface GradingTransformProfile

getGradeSystemTransformRecordTypes, supportsGradeSystemTransformAdmin, supportsGradeSystemTransformation, supportsGradeSystemTransformLookup, supportsGradeSystemTransformNotification, supportsGradeSystemTransformRecordType, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getGradeSystemTransformRecordTypes()	Gets the supported GradeSystemTransform record types.
boolean	supportsGradeSystemTransformAdmin()	Tests if a grade system transform admin service is supported.
boolean	supportsGradeSystemTransformation()	Tests if a grade system transformation service is supported.
boolean	supportsGradeSystemTransformLookup()	Tests if a grade system transform lookup service is supported.
boolean	supportsGradeSystemTransformNotification()	Tests if a grade system transform notification service is supported.
boolean	supportsGradeSystemTransformRecordType(Type gradeSystemTransformRecordType)	Tests if the given GradeSystemTransform 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

getGradeSystemTransformationSession

GradeSystemTransformationSession getGradeSystemTransformationSession(Id sourceGradeSystemId,
 Id targetGradeSystemId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

Gets the session for transforming grades among grade systems. The available transformations can be examined through the GradeSystemTransformLookupSession .

Parameters:

sourceGradeSystemId - the Id of the source grade system

targetGradeSystemId - the Id of the target grade system

proxy - a proxy

Returns:

a GradeSystemTransformationSession

Throws:

NotFoundException - no transform exists between souceGradebookId and targetGradeSystemId

NullArgumentException - sourceGradeSystemId, targetGradeSystemIdId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemTransformation() is false

Compliance:

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

getGradeSystemTransformLookupSession

GradeSystemTransformLookupSession getGradeSystemTransformLookupSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the grade system transform lookup service.

Parameters:

proxy - a proxy

Returns:

a GradeSystemTransformLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemTransformLookup() is false

Compliance:

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

getGradeSystemTransformLookupSessionForGradebook

GradeSystemTransformLookupSession getGradeSystemTransformLookupSessionForGradebook(Id gradebookId,
 Proxy proxy)
                                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeSystemTransformLookupSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemTransformLookup() or supportsVisibleFederation() is false

Compliance:

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

getGradeSystemTransformAdminSession

GradeSystemTransformAdminSession getGradeSystemTransformAdminSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the grade system transform admin service.

Parameters:

proxy - a proxy

Returns:

a GradeSystemTransformAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemTransformAdmin() is false

Compliance:

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

getGradeSystemTransformAdminSessionForGradebook

GradeSystemTransformAdminSession getGradeSystemTransformAdminSessionForGradebook(Id gradebookId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeSystemTransformAdminSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemTransformAdmin() or supportsVisibleFederation() is false

Compliance:

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

getGradeSystemTransformNotificationSession

GradeSystemTransformNotificationSession getGradeSystemTransformNotificationSession(GradeSystemTransformReceiver gradeSystemTransformReceiver,
 Proxy proxy)
                                                                            throws OperationFailedException

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

Parameters:

gradeSystemTransformReceiver - the grade system transform receiver interface

proxy - a proxy

Returns:

a GradeSystemTransformNotificationSession

Throws:

NullArgumentException - gradeSystemReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemTransformNotification() is false

Compliance:

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

getGradeSystemTransformNotificationSessionForGradebook

GradeSystemTransformNotificationSession getGradeSystemTransformNotificationSessionForGradebook(GradeSystemTransformReceiver gradeSystemTransformReceiver,
 Id gradebookId,
 Proxy proxy)
                                                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

gradeSystemTransformReceiver - the grade system transform receiver interface

gradebookId - the Id of the gradebook

proxy - a proxy

Returns:

a GradeSystemTransformNotificationSession

Throws:

NotFoundException - gradebookId not found

NullArgumentException - gradeSystemReceiver, gradebookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsGradeSystemTransformNotification() or supportsVisibleFederation() is false

Compliance:

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