org.osid.course.requisite

Interface CourseRequirementForm

All Superinterfaces:

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

public interface CourseRequirementForm
extends OsidRuleForm, OsidAggregateableForm

This is the form for creating and updating CourseRequirements. 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

Methods

Modifier and Type	Method and Description
void	clearMinimumEarnedCredits() Clears the minimum earned credits.
void	clearMinimumGrade() Clears the minimum grade.
void	clearMinimumScore() Clears the minimum score.
void	clearMinimumScoreSystem() Clears the minimum score system.
void	clearRequiresCompletion() Clears the requires completion flag.
void	clearTimeframe() Clears the timeframe.
CourseRequirementFormRecord	getCourseRequirementFormRecord(Type courseRequirementRecordType) Gets the CourseRequirementFormRecord corresponding to the given course requirement record Type.
Metadata	getMinimumEarnedCreditsMetadata() Gets the metadata for the minimum earned credits
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	getRequiresCompletionMetadata() Gets the metadata for the requires completion flag.
Metadata	getTimeframeMetadata() Gets the metadata for the timeframe.
void	setMinimumEarnedCredits(java.math.BigDecimal credits) Sets the minimum earned credits.
void	setMinimumGrade(Id gradeId) Sets the minimum grade.
void	setMinimumScore(java.math.BigDecimal score) Sets the minimum score.
void	setMinimumScoreSystem(Id gradeSystemId) Sets the minimum score system.
void	setRequiresCompletion(boolean completion) Sets the requires completion flag.
void	setTimeframe(Duration duration) Sets the timeframe.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getRequiresCompletionMetadata

Metadata getRequiresCompletionMetadata()

Gets the metadata for the requires completion flag.

Returns:

metadata for the requires completion flag

Compliance:

mandatory - This method must be implemented.

setRequiresCompletion

void setRequiresCompletion(boolean completion)

Sets the requires completion flag.

Parameters:

completion - the new requires completion flag

Throws:

InvalidArgumentException - completion is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRequiresCompletion

void clearRequiresCompletion()

Clears the requires completion flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

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(java.math.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.

getMinimumEarnedCreditsMetadata

Metadata getMinimumEarnedCreditsMetadata()

Gets the metadata for the minimum earned credits

Returns:

metadata for the minimum earned credits

Compliance:

mandatory - This method must be implemented.

setMinimumEarnedCredits

void setMinimumEarnedCredits(java.math.BigDecimal credits)

Sets the minimum earned credits.

Parameters:

credits - the new minimum earned credits

Throws:

InvalidArgumentException - credits is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMinimumEarnedCredits

void clearMinimumEarnedCredits()

Clears the minimum earned credits.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCourseRequirementFormRecord

CourseRequirementFormRecord getCourseRequirementFormRecord(Type courseRequirementRecordType)
                                                           throws OperationFailedException

Gets the CourseRequirementFormRecord corresponding to the given course requirement record Type.

Parameters:

courseRequirementRecordType - a course requirement record type

Returns:

the course requirement form record

Throws:

NullArgumentException - courseRequirementRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseRequirementRecordType) is false

Compliance:

mandatory - This method must be implemented.