org.osid.course.requisite

Interface Requisite

All Superinterfaces:

Browsable, Containable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface Requisite
extends OsidRule, OsidEnabler, Containable

A Requisite represents a requirement. A Requisite has 8 terms for evaluation that must all be true for this Requisite to be satisfied. Additional terms may be defined in the RequisiteRecord.

• CourseRequirements
• ProgramRequirements
• CredentialRequirements
• AssessmentRequirements
• AwardRequirements
• LearningObjectiveRequirements
• an external Rule
• Requisite options for nested OR terms

A Requsite is true if the active Requisite options term AND the CourseRequirements term AND the ProgramRequirements term AND CredentialRequirements term AND the AssessemnetRequirements term AND the LearningObjectiveRequirements AND Rule are all true.

Requisites are also OsidEnablers that have effectiveness and may apply to specific populations of students.

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentRequirement[]	getAssessmentRequirements() Gets the assessment requirements term.
AwardRequirement[]	getAwardRequirements() Gets the award requirements term.
CourseRequirement[]	getCourseRequirements() Gets the course requirements term.
CredentialRequirement[]	getCredentialRequirements() Gets the credential requirements term.
LearningObjectiveRequirement[]	getLearningObjectiveRequirements() Gets the learning objective requirements term.
ProgramRequirement[]	getProgramRequirements() Gets the program requirements term.
Requisite[]	getRequisiteOptions() Gets the requisite options for the Requisite options term.
RequisiteRecord	getRequisiteRecord(Type requisiteRecordType) Gets the requisite record corresponding to the given Requisite record Type.
boolean	hasAssessmentRequirements() Tests if any assessment requirements are defined.
boolean	hasAwardRequirements() Tests if any award requirements are defined.
boolean	hasCourseRequirements() Tests if any course requirements are defined.
boolean	hasCredentialRequirements() Tests if any credential requirements are defined.
boolean	hasLearningObjectiveRequirements() Tests if any learning objective requirements are defined.
boolean	hasProgramRequirements() Tests if any program requirements are defined.
boolean	hasRequisiteOptions() Tests if any requisite options are defined.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

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

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Methods inherited from interface org.osid.Containable

isSequestered

Method Detail

hasRequisiteOptions

boolean hasRequisiteOptions()

Tests if any requisite options are defined. If no requisite options are defined, this requisite term evaluates to true. If requisite options are defined, then at least one Requisite must evaluate to true for the requisite option term to be true.

Returns:

true if any requisite options are defined, false otherwise

Compliance:

mandatory - This method must be implemented.

getRequisiteOptions

Requisite[] getRequisiteOptions()

Gets the requisite options for the Requisite options term. If any active requisite options are available, meeting the requirements of any one of these requisite options evaluates this requisite options term as true. If no active requisite options apply then this term evaluates to false.

Returns:

the requsites

Throws:

IllegalStateException - hasRequisiteOptions() is false

Compliance:

mandatory - This method must be implemented.

hasCourseRequirements

boolean hasCourseRequirements()

Tests if any course requirements are defined. If no course requirements are defined, this course requirements term evaluates to true. If course requirements are defined, then at least one CourseRequirement must evaluate to true for the course requirement term to be true.

Returns:

true if any course requirements are defined, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseRequirements

CourseRequirement[] getCourseRequirements()

Gets the course requirements term. If any CourseRequirements are available, meeting the requirements of any one of the CourseRequirements evaluates this course requirements term as true. If no active course requirements apply then this course requirements term is false.

Returns:

the course requirements

Throws:

IllegalStateException - hasCourseRequirements() is false

Compliance:

mandatory - This method must be implemented.

hasProgramRequirements

boolean hasProgramRequirements()

Tests if any program requirements are defined. If no program requirements are defined, this program requirements term evaluates to true. If program requirements are defined, then at least one ProgramRequirement must evaluate to true for the program requirement term to be true.

Returns:

true if any program requirements are defined, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramRequirements

ProgramRequirement[] getProgramRequirements()

Gets the program requirements term. If any ProgramRequirements are available, meeting the requirements of any one of the ProgramRequirements evaluates this program requirements term as true. If no program requirements apply then this program requirements term evaluates to false.

Returns:

the program requirements

Throws:

IllegalStateException - hasProgramRequirements() is false

Compliance:

mandatory - This method must be implemented.

hasCredentialRequirements

boolean hasCredentialRequirements()

Tests if any credential requirements are defined. If no credential requirements are defined, this credential requirements term evaluates to true. If credential requirements are defined, then at least one CredentialRequirement must evaluate to true for the credential requirement term to be true.

Returns:

true if any credential requirements are defined, false otherwise

Compliance:

mandatory - This method must be implemented.

getCredentialRequirements

CredentialRequirement[] getCredentialRequirements()

Gets the credential requirements term. If any CredentialRequirements are available, meeting the requirements of any one of the CredentialRequirements evaluates this credential requirements term as true. If no credential requirements are available, this credential requirements term evaluates to false.

Returns:

the credential requirements

Throws:

IllegalStateException - hasCredentialRequirements() is false

Compliance:

mandatory - This method must be implemented.

hasLearningObjectiveRequirements

boolean hasLearningObjectiveRequirements()

Tests if any learning objective requirements are defined. If no learning objective requirements are defined, this learning objective requirements term evaluates to true. If learning objective requirements are defined, then at least one LearningObjectiveRequirement must evaluate to true for the learning objective requirement term to be true.

Returns:

true if any learning objective requirements are defined, false otherwise

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveRequirements

LearningObjectiveRequirement[] getLearningObjectiveRequirements()

Gets the learning objective requirements term. If any LearningObjectiveRequirements are available, meeting the requirements of any one of the LearningObjectiveRequirements evaluates this learning objective requirements term as true. If no learning objective requirements applythen this learning objective requirements term evaluates to false.

Returns:

the learning objective requirements

Throws:

IllegalStateException - hasLearningObjectiveRequirements() is false

Compliance:

mandatory - This method must be implemented.

hasAssessmentRequirements

boolean hasAssessmentRequirements()

Tests if any assessment requirements are defined. If no assessment requirements are defined, this assessment requirements term evaluates to true. If assessment requirements are defined, then at least one AssessmentRequirement must evaluate to true for the assessment requirement term to be true.

Returns:

true if any assessment requirements are defined, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentRequirements

AssessmentRequirement[] getAssessmentRequirements()

Gets the assessment requirements term. If any AssessmentRequirements are available, meeting the requirements of any one of the AssessmentRequirements evaluates this assessment requirements term as true. If no assessment requirements are available, this assessment requirements term evaluates to false.

Returns:

the assessment requirements

Throws:

IllegalStateException - hasAssessmentRequirements() is false

Compliance:

mandatory - This method must be implemented.

hasAwardRequirements

boolean hasAwardRequirements()

Tests if any award requirements are defined. If no award requirements are defined, this award requirements term evaluates to true. If award requirements are defined, then at least one AwardRequirement must evaluate to true for the award requirement term to be true.

Returns:

true if any award requirements are defined, false otherwise

Compliance:

mandatory - This method must be implemented.

getAwardRequirements

AwardRequirement[] getAwardRequirements()

Gets the award requirements term. If any AwardRequirements are available, meeting the requirements of any one of the AwardRequirements evaluates this award requirements term as true. If no award requirements are available, this award requirements term evaluates to false.

Returns:

the award requirements

Throws:

IllegalStateException - hasAwardRequirements() is false

Compliance:

mandatory - This method must be implemented.

getRequisiteRecord

RequisiteRecord getRequisiteRecord(Type requisiteRecordType)
                                   throws OperationFailedException

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

Parameters:

requisiteRecordType - the type of requisite record to retrieve

Returns:

the requisite record

Throws:

NullArgumentException - requisiteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requisiteRecordType) is false

Compliance:

mandatory - This method must be implemented.