org.osid.course.requisite

Interface CourseRequirement

All Superinterfaces:

Aggregateable, Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule

public interface CourseRequirement
extends OsidRule, Aggregateable

A CourseRequirement is an OsidRule and represents a requirement based on the completion or a co-requsite of a course.

Method Summary

Methods

Modifier and Type	Method and Description
Requisite[]	getAltRequisites() Gets any Requisites that may be substituted in place of this CourseRequirement.
Course	getCourse() Gets the Course.
Id	getCourseId() Gets the Id of the Course.
CourseRequirementRecord	getCourseRequirementRecord(Type courseRequirementRecordType) Gets the course requirement record corresponding to the given CourseRequirement record Type.
java.math.BigDecimal	getMinimumEarnedCredits() Gets the minimum earned credits.
Grade	getMinimumGrade() Gets the minimum grade.
Id	getMinimumGradeId() Gets the minimum grade Id.
java.math.BigDecimal	getMinimumScore() Gets the minimum score.
GradeSystem	getMinimumScoreSystem() Gets the scoring system for the minimum score.
Id	getMinimumScoreSystemId() Gets the scoring system Id for the minimum score.
Duration	getTimeframe() Gets the timeframe in which the course has to be completed.
boolean	hasMinimumEarnedCredits() Tests if a minimum credits earned from the completion of the course, or registered for in a co-requisite is required.
boolean	hasMinimumGrade() Tests if a minimum grade above passing is required in the completion of the course or maintained at this level during a co-requisite.
boolean	hasMinimumScore() Tests if a minimum score above passing is required in the completion of the course or maintained at this level during a co-requisite.
boolean	hasTimeframe() Tests if the course must be completed within the required duration.
boolean	requiresCompletion() Tests if this requirement requires completion of the course with a passing grade.

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

getAltRequisites

Requisite[] getAltRequisites()

Gets any Requisites that may be substituted in place of this CourseRequirement. All Requisites must be satisifed to be a substitute for this course requirement. Inactive Requisites are not evaluated but if no applicable requisite exists, then the alternate requisite is not satisifed.

Returns:

the alternate requisites

Compliance:

mandatory - This method must be implemented.

getCourseId

Id getCourseId()

Gets the Id of the Course.

Returns:

the course Id

Compliance:

mandatory - This method must be implemented.

getCourse

Course getCourse()
                 throws OperationFailedException

Gets the Course.

Returns:

the course

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

requiresCompletion

boolean requiresCompletion()

Tests if this requirement requires completion of the course with a passing grade.

Returns:

true if a completion of the course is required, false is the course is a co-requisite

Compliance:

mandatory - This method must be implemented.

hasTimeframe

boolean hasTimeframe()

Tests if the course must be completed within the required duration.

Returns:

true if the course must be completed within a required time, false if it could have been completed at any time in the past

Compliance:

mandatory - This method must be implemented.

getTimeframe

Duration getTimeframe()

Gets the timeframe in which the course has to be completed. A negative duration indicates the course had to be completed within the specified amount of time in the past. A posiitive duration indicates the course must be completed within the specified amount of time in the future. A zero duration indicates the course must be completed in the current term.

Returns:

the time frame

Throws:

IllegalStateException - hasTimeframe() is false

Compliance:

mandatory - This method must be implemented.

hasMinimumGrade

boolean hasMinimumGrade()

Tests if a minimum grade above passing is required in the completion of the course or maintained at this level during a co-requisite.

Returns:

true if a minimum grade is required, false if the course just has to be passed

Compliance:

mandatory - This method must be implemented.

getMinimumGradeId

Id getMinimumGradeId()

Gets the minimum grade Id.

Returns:

the minimum grade Id

Throws:

IllegalStateException - hasMinimumGrade() is false

Compliance:

mandatory - This method must be implemented.

getMinimumGrade

Grade getMinimumGrade()
                      throws OperationFailedException

Gets the minimum grade.

Returns:

the minimum grade

Throws:

IllegalStateException - hasMinimumGrade() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasMinimumScore

boolean hasMinimumScore()

Tests if a minimum score above passing is required in the completion of the course or maintained at this level during a co-requisite.

Returns:

true if a minimum score is required, false if the course just has to be passed

Compliance:

mandatory - This method must be implemented.

getMinimumScoreSystemId

Id getMinimumScoreSystemId()

Gets the scoring system Id for the minimum score.

Returns:

the scoring system Id

Throws:

IllegalStateException - hasMinimumScore() is false

Compliance:

mandatory - This method must be implemented.

getMinimumScoreSystem

GradeSystem getMinimumScoreSystem()
                                  throws OperationFailedException

Gets the scoring system for the minimum score.

Returns:

the scoring system

Throws:

IllegalStateException - hasMinimumScore() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getMinimumScore

java.math.BigDecimal getMinimumScore()

Gets the minimum score.

Returns:

the minimum score

Throws:

IllegalStateException - hasMinimumScore() is false

Compliance:

mandatory - This method must be implemented.

hasMinimumEarnedCredits

boolean hasMinimumEarnedCredits()

Tests if a minimum credits earned from the completion of the course, or registered for in a co-requisite is required.

Returns:

true if a minimum credits is required, false otehrwise

Compliance:

mandatory - This method must be implemented.

getMinimumEarnedCredits

java.math.BigDecimal getMinimumEarnedCredits()

Gets the minimum earned credits.

Returns:

the minimum credits

Throws:

IllegalStateException - hasMinimumEarnedCredits() is false

Compliance:

mandatory - This method must be implemented.

getCourseRequirementRecord

CourseRequirementRecord getCourseRequirementRecord(Type courseRequirementRecordType)
                                                   throws OperationFailedException

Gets the course requirement record corresponding to the given CourseRequirement record Type. This method is used to retrieve an object implementing the requested record. The courseRequirementRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(courseRequirementRecordType) is true .

Parameters:

courseRequirementRecordType - the type of course requirement record to retrieve

Returns:

the course requirement record

Throws:

NullArgumentException - courseRequirementRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseRequirementRecordType) is false

Compliance:

mandatory - This method must be implemented.