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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

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.