OSID Specifications
course requisite package
Version 3.1.0
course requisite package
Version 3.1.0
| Interface | osid.course.requisite.LearningObjectiveRequirementSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRuleSearchOrder | ||
osid.OsidAggregateableSearchOrder | |||
| Description |
An interface for specifying the ordering of
| ||
| Method | orderByIncludeEquivalentUnits | ||
| Description |
Specifies a preference for ordering results by the include equivalent units flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRequiresMinimumNumber | ||
| Description |
Specifies a preference for ordering results by the requires minimum number flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumNumber | ||
| Description |
Specifies a preference for ordering results by minimum number. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByHasTargetNumberForSet | ||
| Description |
Specifies a preference for ordering results by the has target number for set flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByTargetSetNumber | ||
| Description |
Specifies a preference for ordering results by target set number. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByHasMinimumProficiency | ||
| Description |
Specifies a preference for ordering results by the has minimum proficiency flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumProficiency | ||
| Description |
Specifies a preference for ordering results by minimum proficiency. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsMinimumProficiencySearchOrder | ||
| Description |
Tests if a minimum proficiency search order is available. | ||
| Return | boolean | true if a minimum proficiency search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumProficiencySearchOrder | ||
| Description |
Gets the search order for a minimum proficiency. | ||
| Return | osid.grading.GradeSearchOrder | the search order | |
| Errors | UNIMPLEMENTED | supportsMinimumProficiencySearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsMinimumProficiencySearchOrder() is true. | |
| Method | getLearningObjectiveRequirementSearchOrderRecord | ||
| Description |
Gets the search order record corresponding to the
given | ||
| Parameters | osid.type.Type | learningObjectiveRequirementSearchOrderRecordType | a LearningObjectiveRequirement record type |
| Return | osid.course.requisite.records.LearningObjectiveRequirementSearchOrderRecord | the search order record | |
| Errors | NULL_ARGUMENT | learningObjectiveRequirementSearchOrderRecordType is
null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |
hasRecordType(learningObjectiveRequirementSearchOrderRecordType)
is false | ||
| Compliance | mandatory | This method must be implemented. | |