Requisite
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
ORterms
A Requisite 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.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Temporal | |||
isEffective |
boolean | true if this is effective, false otherwise |
|
startDate |
datetime | the start date | |
endDate |
datetime | the end date | |
| OsidEnabler | |||
isRequirement |
boolean | true if this enabler is a requirement, false
otherwise |
|
isOperationalOnSchedule |
boolean | true if the enabler is operational on a schedule,
false otherwise |
|
scheduleId |
id | the schedule Id |
|
schedule |
Schedule | the schedule | |
isOperationalDuringEvent |
boolean | true if the enabler is operational for an event,
false otherwise |
|
eventId |
id | the event Id |
|
event |
Event | the event | |
isOperationalDuringCyclicEvent |
boolean | true if the enabler is governed by a cyclic event,
false otherwise |
|
cyclicEventId |
id | the cyclic event Id |
|
cyclicEvent |
CyclicEvent | the cyclic event | |
isOperationalDuringTimePeriod |
boolean | true if the enabler applied to a time period,
false otherwise |
|
timePeriodId |
id | the time period Id |
|
timePeriod |
TimePeriod | the time period | |
isOperationalDuringCyclicTimePeriod |
boolean | true if the enabler is appleid to a cycic time period,
false otherwise |
|
cyclicTimePeriodId |
id | the cyclic time period Id |
|
cyclicTimePeriod |
CyclicTimePeriod | the cyclic time period | |
| Containable | |||
isSequestered |
boolean | true if this containable is sequestered, false
if this containable may appear outside its aggregate |
|
| Name | Syntax | Many | Description |
|---|---|---|---|
hasRequisiteOptions |
boolean | true if any requisite options are defined, false
otherwise |
|
requisiteOptions |
Requisite | the requisites | |
hasCourseRequirements |
boolean | true if any course requirements are defined,
false otherwise |
|
courseRequirements |
CourseRequirement | the course requirements | |
hasProgramRequirements |
boolean | true if any program requirements are defined,
false otherwise |
|
programRequirements |
ProgramRequirement | the program requirements | |
hasCredentialRequirements |
boolean | true if any credential requirements are defined,
false otherwise |
|
credentialRequirements |
CredentialRequirement | the credential requirements | |
hasLearningObjectiveRequirements |
boolean | true if any learning objective requirements are defined,
false otherwise |
|
learningObjectiveRequirements |
LearningObjectiveRequirement | the learning objective requirements | |
hasAssessmentRequirements |
boolean | true if any assessment requirements are defined,
false otherwise |
|
assessmentRequirements |
AssessmentRequirement | the assessment requirements | |
hasAwardRequirements |
boolean | true if any award requirements are defined,
false otherwise |
|
awardRequirements |
AwardRequirement | the award requirements |
Course Requirement
A CourseRequirement is an
OsidRule and represents a requirement
based on the completion or a co-requisite of a course.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Name | Syntax | Many | Description |
|---|---|---|---|
altRequisites |
Requisite | the alternate requisites | |
courseIds |
id | ⋆ | the course Ids |
courses |
Course | ⋆ | the courses |
requiresSubjectArea |
boolean | true if a subject area is required, false
otherwise |
|
subjectAreaId |
id | the subject area Id |
|
subjectArea |
Subject | the subject area | |
includeEquivalentUnits |
boolean | true if equivalent courses are acceptable, false
otherwise |
|
requiresMinimumNumber |
boolean | true if a minimum number of courses is required,
false otherwise |
|
minimumNumber |
cardinal | the minimum number of courses | |
requiresMinimumNonTransferNumber |
boolean | true if a minimum number of non-transfer courses is required,
false otherwise |
|
minimumNonTransferNumber |
cardinal | the minimum number of non-transfer courses | |
hasTargetNumberForSet |
boolean | true if the set has a minimum course count,
false otherwise |
|
targetSetNumber |
cardinal | the minimum number of courses in the set | |
requiresMinimumCredits |
boolean | true if a minimum number of credits is required,
false otherwise |
|
creditScaleId |
id | the credit scale Id |
|
creditScale |
GradeSystem | the credit scale | |
minimumCredits |
decimal | the minimum credits | |
requiresMinimumNonTransferCredits |
boolean | true if a minimum number of non-transfer credits is required,
false otherwise |
|
nonTransferCredits |
decimal | the minimum non-transfer credits | |
hasTargetCreditsForSet |
boolean | true if the set has a minimum credit count,
false otherwise |
|
targetSetCredits |
decimal | the minimum credits in the set | |
requiresCompletion |
boolean | true if a completion of the course is required,
false is the course is a co-requisite |
|
hasTimeframe |
boolean | true if the course must be completed within a required time,
false if it could have been completed at any time in the past |
|
timeframe |
duration | the time frame | |
hasMinimumGrade |
boolean | true if a minimum grade is required, false if
the course just has to be passed |
|
minimumGradeId |
id | the minimum grade Id |
|
minimumGrade |
Grade | the minimum grade | |
hasMinimumScore |
boolean | true if a minimum score is required, false if
the course just has to be passed |
|
minimumScoreSystemId |
id | the scoring system Id |
|
minimumScoreSystem |
GradeSystem | the scoring system | |
minimumScore |
decimal | the minimum score | |
hasMinimumEarnedCredits |
boolean | true if a minimum credits is required, false
otehrwise |
|
minimumEarnedCredits |
decimal | the minimum credits |
Program Requirement
A ProgramRequirement is an
OsidRule and represents a requirement
based on the completion or enrollment for a
Program.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Name | Syntax | Many | Description |
|---|---|---|---|
altRequisites |
Requisite | the alternate requisites | |
programId |
id | the program Id |
|
program |
Program | the program | |
requiresCompletion |
boolean | true if a completion of the program is required,
false if enrollment in the program is required |
|
hasTimeframe |
boolean | true if the program has to be completed within a required
time, false if it could have been completed at any time in the
past |
|
timeframe |
duration | the time frame | |
hasMinimumGPA |
boolean | true if a minimum gpa is required, false if the
course just has to be passed |
|
minimumGPASystemId |
id | the scoring system Id |
|
minimumGPASystem |
GradeSystem | the scoring system | |
minimumGPA |
decimal | the minimum gpa | |
hasMinimumEarnedCredits |
boolean | true if a minimum credits is required, false
otehrwise |
|
minimumEarnedCredits |
decimal | the minimum credits |
Credential Requirement
A CredentialRequirement is an
OsidRule and represents a requirement
based on a Credential.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Name | Syntax | Many | Description |
|---|---|---|---|
altRequisites |
Requisite | the alternate requisites | |
credentialId |
id | the credential Id |
|
credential |
Credential | the credential | |
hasTimeframe |
boolean | true if the credential must be earned within a required time,
false if it could have been earned at any time in the past |
|
timeframe |
duration | the time frame |
Learning Objective Requirement
A LearningObjectiveRequirement is an
OsidRule and represents a requirement
based on a learning Objective.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Name | Syntax | Many | Description |
|---|---|---|---|
altRequisites |
Requisite | the alternate requisites | |
learningObjectiveId |
id | the learning objective Id |
|
learningObjective |
Objective | the learning objective | |
hasMinimumProficiency |
boolean | true if a minimum proficiency is required, false
otherwise |
|
minimumProficiencyId |
id | the minimum proficiency | |
minimumProficiency |
Grade | the minimum proficiency |
Assessment Requirement
A AssessmentRequirement is an
OsidRule and represents a requirement
based on an Assessment.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |
| Name | Syntax | Many | Description |
|---|---|---|---|
altRequisites |
Requisite | the alternate requisites | |
assessmentId |
id | the assessment Id |
|
assessment |
Assessment | the assessment | |
hasTimeframe |
boolean | 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 |
|
timeframe |
duration | the time frame | |
hasMinimumGrade |
boolean | true if a minimum grade is required, false if
the course just has to be passed |
|
minimumGradeId |
id | the minimum grade Id |
|
minimumGrade |
Grade | the minimum grade | |
hasMinimumScore |
boolean | true if a minimum score is required, false if
the course just has to be passed |
|
minimumScoreSystemId |
id | the scoring system Id |
|
minimumScoreSystem |
GradeSystem | the scoring system | |
minimumScore |
decimal | the minimum score |
Award Requirement
A AwardRequirement is an
OsidRule and represents a requirement
based on an Award.
| Name | Syntax | Many | Description |
|---|---|---|---|
| Identifiable | |||
id |
id | the Id |
|
| Extensible | |||
recordTypes |
type | ⋆ | the record types available |
| Browsable | |||
properties |
Property | ⋆ | a list of properties |
| OsidObject | |||
displayName |
displaytext | the display name | |
description |
displaytext | the description | |
genusType |
type | the genus type of this object | |
| Operable | |||
isActive |
boolean | true if this operable is active, false if it is
inactive |
|
isEnabled |
boolean | true if this operable is enabled, false if the
active status is determined by other rules |
|
isDisabled |
boolean | true if this operable is disabled, false if the
active status is determined by other rules |
|
isOperational |
boolean | true if this operable is operational, false
otherwise |
|
| OsidRule | |||
hasRule |
boolean | true if an explicit rule is available, false
otherwise |
|
ruleId |
id | the rule Id |
|
rule |
Rule | the rule | |
conditionRecordTypes |
type | ⋆ | a list of OsidCondition record Types |