org.osid.grading

Interface GradebookForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

GradebookBatchForm

public interface GradebookForm
extends OsidCatalogForm

This is the form for creating and updating Gradebooks. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the GradebookAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
GradebookFormRecord	getGradebookFormRecord(Type gradebookRecordType) Gets the GradebookFormRecord corresponding to the given gradebook record Type.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getGradebookFormRecord

GradebookFormRecord getGradebookFormRecord(Type gradebookRecordType)
                                           throws OperationFailedException

Gets the GradebookFormRecord corresponding to the given gradebook record Type.

Parameters:

gradebookRecordType - a gradebook record type

Returns:

the gradebook form record

Throws:

NullArgumentException - gradebookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookRecordType) is false

Compliance:

mandatory - This method must be implemented.