Interface AssessmentRequirementForm

All Superinterfaces:

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

public interface AssessmentRequirementForm
extends OsidRuleForm, OsidAggregateableForm

This is the form for creating and updating AssessmentRequirements. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RequisiteAdminSession. 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	clearMinimumGrade()	Clears the minimum grade.
void	clearMinimumScore()	Clears the minimum score.
void	clearMinimumScoreSystem()	Clears the minimum score system.
void	clearTimeframe()	Clears the timeframe.
AssessmentRequirementFormRecord	getAssessmentRequirementFormRecord(Type assessmentRequirementRecordType)	Gets the AssessmentRequirementFormRecord corresponding to the given assessment requirement record Type.
Metadata	getMinimumGradeMetadata()	Gets the metadata for the minimum grade.
Metadata	getMinimumScoreMetadata()	Gets the metadata for the minimum score.
Metadata	getMinimumScoreSystemMetadata()	Gets the metadata for the minimum score system.
Metadata	getTimeframeMetadata()	Gets the metadata for the timeframe.
void	setMinimumGrade(Id gradeId)	Sets the minimum grade.
void	setMinimumScore(BigDecimal score)	Sets the minimum score.
void	setMinimumScoreSystem(Id gradeSystemId)	Sets the minimum score system.
void	setTimeframe(Duration duration)	Sets the timeframe.

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.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getTimeframeMetadata

Metadata getTimeframeMetadata()

Gets the metadata for the timeframe.

Returns:

metadata for the timeframe

Compliance:

mandatory - This method must be implemented.

setTimeframe

void setTimeframe(Duration duration)

Sets the timeframe.

Parameters:

duration - the new duration

Throws:

InvalidArgumentException - duration is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - duration is null

Compliance:

mandatory - This method must be implemented.

clearTimeframe

void clearTimeframe()

Clears the timeframe.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getMinimumGradeMetadata

Metadata getMinimumGradeMetadata()

Gets the metadata for the minimum grade.

Returns:

metadata for the minimum grade

Compliance:

mandatory - This method must be implemented.

setMinimumGrade

void setMinimumGrade(Id gradeId)

Sets the minimum grade.

Parameters:

gradeId - the new grade

Throws:

InvalidArgumentException - gradeId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearMinimumGrade

void clearMinimumGrade()

Clears the minimum grade.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getMinimumScoreSystemMetadata

Metadata getMinimumScoreSystemMetadata()

Gets the metadata for the minimum score system.

Returns:

metadata for the minimum score system

Compliance:

mandatory - This method must be implemented.

setMinimumScoreSystem

void setMinimumScoreSystem(Id gradeSystemId)

Sets the minimum score system.

Parameters:

gradeSystemId - the new grade system

Throws:

InvalidArgumentException - gradeSystemId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearMinimumScoreSystem

void clearMinimumScoreSystem()

Clears the minimum score system.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getMinimumScoreMetadata

Metadata getMinimumScoreMetadata()

Gets the metadata for the minimum score.

Returns:

metadata for the minimum score

Compliance:

mandatory - This method must be implemented.

setMinimumScore

void setMinimumScore(BigDecimal score)

Sets the minimum score.

Parameters:

score - the new minimum score

Throws:

InvalidArgumentException - score is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMinimumScore

void clearMinimumScore()

Clears the minimum score.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAssessmentRequirementFormRecord

AssessmentRequirementFormRecord getAssessmentRequirementFormRecord(Type assessmentRequirementRecordType)
                                                            throws OperationFailedException

Gets the AssessmentRequirementFormRecord corresponding to the given assessment requirement record Type.

Parameters:

assessmentRequirementRecordType - an assessment requirement record type

Returns:

the assessment requirement form record

Throws:

NullArgumentException - assessmentRequirementRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentRequirementRecordType) is false

Compliance:

mandatory - This method must be implemented.