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.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getGradeSystemMetadata()
mandatory
- This method must be implemented. void setGradeSystem(Id gradeSystemId)
gradeSystemId
- the new grade systemInvalidArgumentException
- gradeSystemId
is invalidNoAccessException
- gradeSystemId
cannot
be modifiedNullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearGradeSystem()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. GradebookColumnFormRecord getGradebookColumnFormRecord(Type gradebookColumnRecordType) throws OperationFailedException
GradebookColumnFormRecord
corresponding to the
given gradebook column record Type.
gradebookColumnRecordType
- a gradebook column record typeNullArgumentException
-
gradebookColumnRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradebookColumnRecordType)
is
false
mandatory
- This method must be implemented.