public interface ResultForm extends OsidObjectForm, OsidTemporalForm, OsidSubjugateableForm
This is the form for creating and updating Result
objects. Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
ResultAdminSession.
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 |
clearGrade()
Clears the grade.
|
void |
clearValue()
Clears the value.
|
Metadata |
getGradeMetadata()
Gets the metadata for a grade.
|
ResultFormRecord |
getResultFormRecord(Type resultRecordType)
Gets the
ResultFormRecord interface corresponding to
the given result record Type. |
Metadata |
getValueMetadata()
Gets the metadata for a value/
|
void |
setGrade(Id gradeId)
Sets the grade.
|
void |
setValue(java.math.BigDecimal value)
Sets the value.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getGradeMetadata()
mandatory
- This method must be implemented. void setGrade(Id gradeId)
gradeId
- the grade Id
InvalidArgumentException
- gradeId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeId
is
null
mandatory
- This method must be implemented. void clearGrade()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getValueMetadata()
mandatory
- This method must be implemented. void setValue(java.math.BigDecimal value)
value
- the valueInvalidArgumentException
- value
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearValue()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ResultFormRecord getResultFormRecord(Type resultRecordType) throws OperationFailedException
ResultFormRecord
interface corresponding to
the given result record Type.
resultRecordType
- the result record typeNullArgumentException
- resultRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(resultRecordType)
is false
mandatory
- This method must be implemented.