org.osid.grading

Interface GradebookColumnForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

GradebookColumnBatchForm

public interface GradebookColumnForm
extends OsidObjectForm

This is the form for creating and updating GradebookColumns. 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
void	clearGradeSystem() Clears the grade system
GradebookColumnFormRecord	getGradebookColumnFormRecord(Type gradebookColumnRecordType) Gets the GradebookColumnFormRecord corresponding to the given gradebook column record Type.
Metadata	getGradeSystemMetadata() Gets the metadata for a grade system.
void	setGradeSystem(Id gradeSystemId) Sets the grade system.

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

Method Detail

getGradeSystemMetadata

Metadata getGradeSystemMetadata()

Gets the metadata for a grade system.

Returns:

metadata for the grade system

Compliance:

mandatory - This method must be implemented.

setGradeSystem

void setGradeSystem(Id gradeSystemId)

Sets the grade system.

Parameters:

gradeSystemId - the new grade system

Throws:

InvalidArgumentException - gradeSystemId is invalid

NoAccessException - gradeSystemId cannot be modified

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearGradeSystem

void clearGradeSystem()

Clears the grade system

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getGradebookColumnFormRecord

GradebookColumnFormRecord getGradebookColumnFormRecord(Type gradebookColumnRecordType)
                                                       throws OperationFailedException

Gets the GradebookColumnFormRecord corresponding to the given gradebook column record Type.

Parameters:

gradebookColumnRecordType - a gradebook column record type

Returns:

the gradebook column form record

Throws:

NullArgumentException - gradebookColumnRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookColumnRecordType) is false

Compliance:

mandatory - This method must be implemented.