public interface GradebookColumnCalculationForm extends OsidObjectForm
This is the form for creating and updating
GradebookColumnCalculations.
Like all OsidForm
objects, various data elements may be set here for use in the create and
update methods in the GradebookColumnCalculationSession.
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 |
clearInputGradebookColumns()
Clears the Input gradebook columns.
|
void |
clearTweakedCenter()
Clears the tweaked center.
|
void |
clearTweakedStandarDeviation()
Clears the tweaked standard deviation.
|
GradebookColumnCalculationFormRecord |
getGradebookColumnCalculationFormRecord(Type gradebookColumnCalculationRecordType)
Gets the
GradebookColumnCalculationFormRecord
corresponding to the given gradebook column calculation record
Type. |
Metadata |
getInputGradebookColumnsMetadata()
Gets the metadata for the input gradebook columns.
|
Metadata |
getOperationMetadata()
Gets the metadata for the calculation operation.
|
Metadata |
getTweakedCenterMetadata()
Gets the metadata for the tweaked center.
|
Metadata |
getTweakedStandardDeviation()
Gets the metadata for the tweaked standard deviation.
|
void |
setInputGradebookColumns(CalculationOperation gradebookColumnIds)
Sets the input gradebook columns.
|
void |
setOperation(CalculationOperation operation)
Sets the operation.
|
void |
setTweakedCenter(java.math.BigDecimal center)
Sets the tweaked center.
|
void |
setTweakedStandardDeviation(java.math.BigDecimal standardDeviation)
Sets the tweaked standard deviation.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getInputGradebookColumnsMetadata()
mandatory
- This method must be implemented. void setInputGradebookColumns(CalculationOperation gradebookColumnIds)
gradebookColumnIds
- the new input gradebook columnsInvalidArgumentException
- gradebookColumnIds
is invalidNoAccessException
- gradebookColumnIds
cannot be modifiedNullArgumentException
- gradebookColumnIds
is null
mandatory
- This method must be implemented. void clearInputGradebookColumns()
mandatory
- This method must be implemented. Metadata getOperationMetadata()
mandatory
- This method must be implemented. void setOperation(CalculationOperation operation)
operation
- the new calculation operationInvalidArgumentException
- operation
is
invalidNoAccessException
- operation
cannot be
modifiedmandatory
- This method must be implemented. Metadata getTweakedCenterMetadata()
mandatory
- This method must be implemented. void setTweakedCenter(java.math.BigDecimal center)
center
- the new tweaked centerInvalidArgumentException
- center
is
invalidNoAccessException
- center
cannot be
modifiedmandatory
- This method must be implemented. void clearTweakedCenter()
mandatory
- This method must be implemented. Metadata getTweakedStandardDeviation()
mandatory
- This method must be implemented. void setTweakedStandardDeviation(java.math.BigDecimal standardDeviation)
standardDeviation
- the new tweaked standard deviationInvalidArgumentException
- standardDeviation
is invalidNoAccessException
- standardDeviation
cannot be modifiedmandatory
- This method must be implemented. void clearTweakedStandarDeviation()
mandatory
- This method must be implemented. GradebookColumnCalculationFormRecord getGradebookColumnCalculationFormRecord(Type gradebookColumnCalculationRecordType) throws OperationFailedException
GradebookColumnCalculationFormRecord
corresponding to the given gradebook column calculation record
Type.
gradebookColumnCalculationRecordType
- the gradeboo column
calculation record typeNullArgumentException
-
gradebookColumnCalculationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradebookColumnCalculationRecordType)
is
false
mandatory
- This method must be implemented.