Interface GradeSystemForm

All Superinterfaces:

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

All Known Subinterfaces:

GradeSystemBatchForm

public interface GradeSystemForm
extends OsidObjectForm, OsidAggregateableForm

This is the form for creating and updating GradeSystems. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the GradeSystemAdminSession. 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	clearBasedOnGrades()	Clears the based on grades designation.
void	clearHighestNumericScore()	Clears the highest numeric score.
void	clearLowestNumericScore()	Clears the lowest score.
void	clearNumericScoreIncrement()	Clears the numeric score increment.
Metadata	getBasedOnGradesMetadata()	Gets the metadata for a grade-based designation.
GradeSystemFormRecord	getGradeSystemFormRecord(Type gradeSystemRecordType)	Gets the GradeSystemFormRecord corresponding to the given grade system record Type.
Metadata	getHighestNumericScoreMetadata()	Gets the metadata for the highest numeric score.
Metadata	getLowestNumericScoreMetadata()	Gets the metadata for the lowest numeric score.
Metadata	getNumericScoreIncrementMetadata()	Gets the metadata for the lowest numeric score.
void	setBasedOnGrades(boolean grades)	Sets the grade-based designation.
void	setHighestNumericScore(BigDecimal score)	Sets the highest numeric score.
void	setLowestNumericScore(BigDecimal score)	Sets the lowest numeric score.
void	setNumericScoreIncrement(BigDecimal increment)	Sets the numeric score increment.

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

getBasedOnGradesMetadata

Metadata getBasedOnGradesMetadata()

Gets the metadata for a grade-based designation.

Returns:

metadata for the grade-based designation

Compliance:

mandatory - This method must be implemented.

setBasedOnGrades

void setBasedOnGrades(boolean grades)

Sets the grade-based designation.

Parameters:

grades - the grade-based designation

Throws:

InvalidArgumentException - grades is invalid

NoAccessException - grades cannot be modified

Compliance:

mandatory - This method must be implemented.

clearBasedOnGrades

void clearBasedOnGrades()

Clears the based on grades designation.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getLowestNumericScoreMetadata

Metadata getLowestNumericScoreMetadata()

Gets the metadata for the lowest numeric score.

Returns:

metadata for the lowest numeric score

Compliance:

mandatory - This method must be implemented.

setLowestNumericScore

void setLowestNumericScore(BigDecimal score)

Sets the lowest numeric score.

Parameters:

score - the lowest numeric score

Throws:

InvalidArgumentException - score is invalid

NoAccessException - score cannot be modified

Compliance:

mandatory - This method must be implemented.

clearLowestNumericScore

void clearLowestNumericScore()

Clears the lowest score.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getNumericScoreIncrementMetadata

Metadata getNumericScoreIncrementMetadata()

Gets the metadata for the lowest numeric score.

Returns:

metadata for the lowest numeric score

Compliance:

mandatory - This method must be implemented.

setNumericScoreIncrement

void setNumericScoreIncrement(BigDecimal increment)

Sets the numeric score increment.

Parameters:

increment - the numeric score increment

Throws:

InvalidArgumentException - increment is invalid

NoAccessException - increment cannot be modified

Compliance:

mandatory - This method must be implemented.

clearNumericScoreIncrement

void clearNumericScoreIncrement()

Clears the numeric score increment.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getHighestNumericScoreMetadata

Metadata getHighestNumericScoreMetadata()

Gets the metadata for the highest numeric score.

Returns:

metadata for the highest numeric score

Compliance:

mandatory - This method must be implemented.

setHighestNumericScore

void setHighestNumericScore(BigDecimal score)

Sets the highest numeric score.

Parameters:

score - the highest numeric score

Throws:

InvalidArgumentException - score is invalid

NoAccessException - score cannot be modified

Compliance:

mandatory - This method must be implemented.

clearHighestNumericScore

void clearHighestNumericScore()

Clears the highest numeric score.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getGradeSystemFormRecord

GradeSystemFormRecord getGradeSystemFormRecord(Type gradeSystemRecordType)
                                        throws OperationFailedException

Gets the GradeSystemFormRecord corresponding to the given grade system record Type.

Parameters:

gradeSystemRecordType - the grade system record type

Returns:

the grade system form record

Throws:

NullArgumentException - gradeSystemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeSystemRecordType) is false

Compliance:

mandatory - This method must be implemented.