OSID Specifications
course requisite package
Version 3.1.0
course requisite package
Version 3.1.0
| Interface | osid.course.requisite.ProgramRequirementSearchOrder | ||
|---|---|---|---|
| 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 | 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 | orderByHasMinimumGPA | ||
| Description |
Specifies a preference for ordering results by the has minimum gpa flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMinimumGPA | ||
| Description |
Specifies a preference for ordering results by minimum gpa. | ||
| 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 | getProgramRequirementSearchOrderRecord | ||
| Description |
Gets the search order record corresponding to the
given | ||
| Parameters | osid.type.Type | programRequirementSearchOrderRecordType | a ProgramRequirement record type |
| Return | osid.course.requisite.records.ProgramRequirementSearchOrderRecord | the search order record | |
| Errors | NULL_ARGUMENT | programRequirementSearchOrderRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(programRequirementSearchOrderRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |