OSID Specifications
course requisite package
Version 3.1.0
course requisite package
Version 3.1.0
| Interface | osid.course.requisite.CourseRequirementSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRuleSearchOrder | ||
osid.OsidAggregateableSearchOrder | |||
| Description |
An interface for specifying the ordering of
| ||
| Method | orderByRequiresSubjectArea | ||
| Description |
Specifies a preference for ordering results by the requires subject area flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySubjectArea | ||
| Description |
Specifies a preference for ordering results by subject area. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSubjectAreaSearchOrder | ||
| Description |
Tests if a subject area search order is available. | ||
| Return | boolean | true if a subject area search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubjectAreaSearchOrder | ||
| Description |
Gets the search order for a subject area. | ||
| Return | osid.ontology.SubjectSearchOrder | the search order | |
| Errors | UNIMPLEMENTED | supportsSubjectAreaSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsSubjectAreaSearchOrder() is true. | |
| 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 | orderByRequiresMinimumNonTransferNumber | ||
| Description |
Specifies a preference for ordering results by the requires minimum non-transfer number flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumNonTransferNumber | ||
| Description |
Specifies a preference for ordering results by minimum non-transfer 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 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 | orderByRequiresMinimumCredits | ||
| Description |
Specifies a preference for ordering results by the requires minimum credits flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCreditScale | ||
| Description |
Specifies a preference for ordering results by credit scale. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCreditScaleSearchOrder | ||
| Description |
Tests if a credit scale search order is available. | ||
| Return | boolean | true if a credit scale search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditScaleSearchOrder | ||
| Description |
Gets the search order for a credit scale. | ||
| Return | osid.grading.GradeSystemSearchOrder | the search order | |
| Errors | UNIMPLEMENTED | supportsCreditScaleSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsCreditScaleSearchOrder() is true. | |
| Method | orderByMinimumCredits | ||
| Description |
Specifies a preference for ordering results by minimum credits. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRequiresMinimumNonTransferCredits | ||
| Description |
Specifies a preference for ordering results by the requires minimum non-transfer credits flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByNonTransferCredits | ||
| Description |
Specifies a preference for ordering results by non-transfer credits. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByHasTargetCreditsForSet | ||
| Description |
Specifies a preference for ordering results by the target credits for set flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByTargetSetCredits | ||
| Description |
Specifies a preference for ordering results by target set credits. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRequiresCompletion | ||
| Description |
Specifies a preference for ordering results by the requires completion flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByHasMinimumGrade | ||
| Description |
Specifies a preference for ordering results by the has minimum grade flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumGrade | ||
| Description |
Specifies a preference for ordering results by minimum grade. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsMinimumGradeSearchOrder | ||
| Description |
Tests if a minimum grade search order is available. | ||
| Return | boolean | true if a minimum grade search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumGradeSearchOrder | ||
| Description |
Gets the search order for a minimum grade. | ||
| Return | osid.grading.GradeSearchOrder | the search order | |
| Errors | UNIMPLEMENTED | supportsMinimumGradeSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsMinimumGradeSearchOrder() is true. | |
| Method | orderByHasMinimumScore | ||
| Description |
Specifies a preference for ordering results by the has minimum score flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumScore | ||
| Description |
Specifies a preference for ordering results by minimum score. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByHasMinimumEarnedCredits | ||
| Description |
Specifies a preference for ordering results by the has minimum earned credits flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumEarnedCredits | ||
| Description |
Specifies a preference for ordering results by minimum earned credits. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseRequirementSearchOrderRecord | ||
| Description |
Gets the course requirement query record corresponding
to the given | ||
| Parameters | osid.type.Type | courseRequirementSearchOrderRecordType | a course requirement record type |
| Return | osid.course.requisite.records.CourseRequirementSearchOrderRecord | the course requirement search order record | |
| Errors | NULL_ARGUMENT | courseRequirementSearchOrderRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(courseRequirementSearchOrderRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |