Interface GradebookColumnCalculationForm

All Superinterfaces:

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

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.

Method Summary

Modifier and Type	Method	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(Id[] gradebookColumnIds)	Sets the input gradebook columns.
void	setOperation(CalculationOperation operation)	Sets the operation.
void	setTweakedCenter(BigDecimal center)	Sets the tweaked center.
void	setTweakedStandardDeviation(BigDecimal standardDeviation)	Sets the tweaked standard deviation.

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

getInputGradebookColumnsMetadata

Metadata getInputGradebookColumnsMetadata()

Gets the metadata for the input gradebook columns.

Returns:

metadata for the input gradebook columns

Compliance:

mandatory - This method must be implemented.

setInputGradebookColumns

void setInputGradebookColumns(Id[] gradebookColumnIds)

Sets the input gradebook columns.

Parameters:

gradebookColumnIds - the new input gradebook columns

Throws:

InvalidArgumentException - gradebookColumnIds is invalid

NoAccessException - gradebookColumnIds cannot be modified

NullArgumentException - gradebookColumnIds is null

Compliance:

mandatory - This method must be implemented.

clearInputGradebookColumns

void clearInputGradebookColumns()

Clears the Input gradebook columns.

Compliance:

mandatory - This method must be implemented.

getOperationMetadata

Metadata getOperationMetadata()

Gets the metadata for the calculation operation.

Returns:

metadata for the calculation operation

Compliance:

mandatory - This method must be implemented.

setOperation

void setOperation(CalculationOperation operation)

Sets the operation.

Parameters:

operation - the new calculation operation

Throws:

InvalidArgumentException - operation is invalid

NoAccessException - operation cannot be modified

Compliance:

mandatory - This method must be implemented.

getTweakedCenterMetadata

Metadata getTweakedCenterMetadata()

Gets the metadata for the tweaked center.

Returns:

metadata for the tweaked center

Compliance:

mandatory - This method must be implemented.

setTweakedCenter

void setTweakedCenter(BigDecimal center)

Sets the tweaked center.

Parameters:

center - the new tweaked center

Throws:

InvalidArgumentException - center is invalid

NoAccessException - center cannot be modified

Compliance:

mandatory - This method must be implemented.

clearTweakedCenter

void clearTweakedCenter()

Clears the tweaked center.

Compliance:

mandatory - This method must be implemented.

getTweakedStandardDeviation

Metadata getTweakedStandardDeviation()

Gets the metadata for the tweaked standard deviation.

Returns:

metadata for the standard deviation

Compliance:

mandatory - This method must be implemented.

setTweakedStandardDeviation

void setTweakedStandardDeviation(BigDecimal standardDeviation)

Sets the tweaked standard deviation.

Parameters:

standardDeviation - the new tweaked standard deviation

Throws:

InvalidArgumentException - standardDeviation is invalid

NoAccessException - standardDeviation cannot be modified

Compliance:

mandatory - This method must be implemented.

clearTweakedStandarDeviation

void clearTweakedStandarDeviation()

Clears the tweaked standard deviation.

Compliance:

mandatory - This method must be implemented.

getGradebookColumnCalculationFormRecord

GradebookColumnCalculationFormRecord getGradebookColumnCalculationFormRecord(Type gradebookColumnCalculationRecordType)
                                                                      throws OperationFailedException

Gets the GradebookColumnCalculationFormRecord corresponding to the given gradebook column calculation record Type.

Parameters:

gradebookColumnCalculationRecordType - the gradeboo column calculation record type

Returns:

the gradebook column calculation form record

Throws:

NullArgumentException - gradebookColumnCalculationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookColumnCalculationRecordType) is false

Compliance:

mandatory - This method must be implemented.