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.
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.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Requisite[] getAltRequisites()
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.mandatory
- This method must be implemented. Id getCourseId()
Id
of the Course.
Id
mandatory
- This method must be implemented. Course getCourse() throws OperationFailedException
Course.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean requiresCompletion()
true
if a completion of the course is required,
false
is the course is a co-requisitemandatory
- This method must be implemented. boolean hasTimeframe()
true
if the course must be completed within a
required time, false
if it could have been
completed at any time in the pastmandatory
- This method must be implemented. Duration getTimeframe()
IllegalStateException
- hasTimeframe()
is false
mandatory
- This method must be implemented. boolean hasMinimumGrade()
true
if a minimum grade is required,
false
if the course just has to be passedmandatory
- This method must be implemented. Id getMinimumGradeId()
Id.
Id
IllegalStateException
- hasMinimumGrade()
is false
mandatory
- This method must be implemented. Grade getMinimumGrade() throws OperationFailedException
IllegalStateException
- hasMinimumGrade()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasMinimumScore()
true
if a minimum score is required,
false
if the course just has to be passedmandatory
- This method must be implemented. Id getMinimumScoreSystemId()
Id
for the minimum score. Id
IllegalStateException
- hasMinimumScore()
is false
mandatory
- This method must be implemented. GradeSystem getMinimumScoreSystem() throws OperationFailedException
IllegalStateException
- hasMinimumScore()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.math.BigDecimal getMinimumScore()
IllegalStateException
- hasMinimumScore()
is false
mandatory
- This method must be implemented. boolean hasMinimumEarnedCredits()
true
if a minimum credits is required,
false
otehrwisemandatory
- This method must be implemented. java.math.BigDecimal getMinimumEarnedCredits()
IllegalStateException
-
hasMinimumEarnedCredits()
is false
mandatory
- This method must be implemented. CourseRequirementRecord getCourseRequirementRecord(Type courseRequirementRecordType) throws OperationFailedException
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
.courseRequirementRecordType
- the type of course requirement
record to retrieveNullArgumentException
-
courseRequirementRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseRequirementRecordType)
is
false
mandatory
- This method must be implemented.