org.osid.course.requisite

Interface AssessmentRequirement

All Superinterfaces:

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

public interface AssessmentRequirement
extends OsidRule, Aggregateable

A AssessmentRequirement is an OsidRule and represents a requirement based on an Assessment.

Method Summary

Methods

Modifier and Type	Method and Description
Requisite[]	getAltRequisites() Gets any Requisites that may be substituted in place of this AssessmentRequirement.
Assessment	getAssessment() Gets the Assessment.
Id	getAssessmentId() Gets the Id of the Assessment.
AssessmentRequirementRecord	getAssessmentRequirementRecord(Type assessmentRequirementRecordType) Gets the assessment requirement record corresponding to the given AssessmentRequirement record Type.
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 assessment has to be completed.
boolean	hasMinimumGrade() Tests if a minimum grade above passing is required in the completion of the assessment.
boolean	hasMinimumScore() Tests if a minimum score above passing is required in the completion of the assessment.
boolean	hasTimeframe() Tests if the assessment must be completed within the required duration.

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 AssessmentRequirement. All Requisites must be satisifed to be a substitute for this assessment 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.

getAssessmentId

Id getAssessmentId()

Gets the Id of the Assessment.

Returns:

the assessment Id

Compliance:

mandatory - This method must be implemented.

getAssessment

Assessment getAssessment()
                         throws OperationFailedException

Gets the Assessment.

Returns:

the assessment

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasTimeframe

boolean hasTimeframe()

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

Returns:

true if the assessment has to 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 assessment has to be completed. A negative duration indicates the assessment had to be completed within the specified amount of time in the past. A posiitive duration indicates the assessment must be completed within the specified amount of time in the future. A zero duration indicates the assessment 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 assessment.

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 assessment.

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.

getAssessmentRequirementRecord

AssessmentRequirementRecord getAssessmentRequirementRecord(Type assessmentRequirementRecordType)
                                                           throws OperationFailedException

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

Parameters:

assessmentRequirementRecordType - the type of assessment requirement record to retrieve

Returns:

the assessment requirement record

Throws:

NullArgumentException - assessmentRequirementRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentRequirementRecordType) is false

Compliance:

mandatory - This method must be implemented.