org.osid.course.requisite

Interface LearningObjectiveRequirement

All Superinterfaces:

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

public interface LearningObjectiveRequirement
extends OsidRule, Aggregateable

A LearningObjectiveRequirement is an OsidRule and represents a requirement based on a learning Objective.

Method Summary

Methods

Modifier and Type	Method and Description
Requisite[]	getAltRequisites() Gets any Requisites that may be substituted in place of this LearningObjectiveRequirement.
Objective	getLearningObjective() Gets the LearningObjective.
Id	getLearningObjectiveId() Gets the Id of the LearningObjective.
LearningObjectiveRequirementRecord	getLearningObjectiveRequirementRecord(Type learningObjectiveRequirementRecordType) Gets the learning objective requirement record corresponding to the given LearningObjectiveRequirement record Type.
Grade	getMinimumProficiency() Gets the minimum proficiency expressed as a Grade.
Id	getMinimumProficiencyId() Gets the minimum proficiency expressed as a Grade.
boolean	hasMinimumProficiency() Tests if a minimum grade in proficency is required for this learning objective.

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 LearningObjectiveRequirement. All Requisites must be satisifed to be a substitute for this learning objective 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.

getLearningObjectiveId

Id getLearningObjectiveId()

Gets the Id of the LearningObjective.

Returns:

the learning objective Id

Compliance:

mandatory - This method must be implemented.

getLearningObjective

Objective getLearningObjective()
                               throws OperationFailedException

Gets the LearningObjective.

Returns:

the learning objective

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasMinimumProficiency

boolean hasMinimumProficiency()

Tests if a minimum grade in proficency is required for this learning objective.

Returns:

true if a minimum proficiency is required, false otherwise

Compliance:

mandatory - This method must be implemented.

getMinimumProficiencyId

Id getMinimumProficiencyId()

Gets the minimum proficiency expressed as a Grade.

Returns:

the minimum proficiency

Throws:

IllegalStateException - hasMinimumProficiency() is false

Compliance:

mandatory - This method must be implemented.

getMinimumProficiency

Grade getMinimumProficiency()
                            throws OperationFailedException

Gets the minimum proficiency expressed as a Grade.

Returns:

the minimum proficiency

Throws:

IllegalStateException - hasMinimumProficiency() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveRequirementRecord

LearningObjectiveRequirementRecord getLearningObjectiveRequirementRecord(Type learningObjectiveRequirementRecordType)
                                                                         throws OperationFailedException

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

Parameters:

learningObjectiveRequirementRecordType - the type of learning objective requirement record to retrieve

Returns:

the learning objective requirement record

Throws:

NullArgumentException - learningObjectiveRequirementRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(learningObjectiveRequirementRecordType) is false

Compliance:

mandatory - This method must be implemented.