Interface | osid.course.registration.RegistrationSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByActivityBundle | ||
Description |
Specifies a preference for ordering the result set by activity bundle. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActivityBundleSearchOrder | ||
Description |
Tests if an activity bundle search order is available. | ||
Return | boolean | true if an activity bundle search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityBundleSearchOrder | ||
Description |
Gets the activity bundle search order. | ||
Return | osid.course.registration.ActivityBundleSearchOrder | the activity bundle search order | |
Errors | UNIMPLEMENTED | supportsActivityBundleSearchOrder() is false | |
Compliance | optional | This method must be implemented if
supportsActivityBundleSearchOrder() is true. | |
Method | orderByStudent | ||
Description |
Specifies a preference for ordering the result set by student. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsStudentSearchOrder | ||
Description |
Tests if a student search order is available. | ||
Return | boolean | true if a student search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStudentSearchOrder | ||
Description |
Gets the student search order. | ||
Return | osid.resource.ResourceSearchOrder | the student search order | |
Errors | UNIMPLEMENTED | supportsStudentSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsStudentSearchOrder()
is true. | |
Method | orderByGradingOption | ||
Description |
Specifies a preference for ordering the result set by the grading option. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradingOptionSearchOrder | ||
Description |
Tests if a grade system search order is available. | ||
Return | boolean | true if a grade system order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradingOptionSearchOrder | ||
Description |
Gets the grade system search order. | ||
Return | osid.grading.GradeSystemSearchOrder | the grade system search order | |
Errors | UNIMPLEMENTED | supportsGradingOptionSearchOrder() is false | |
Compliance | optional | This method must be implemented if
supportsGradingOptionSearchOrder() is true. | |
Method | getRegistrationSearchOrderRecord | ||
Description |
Gets the registration search order record corresponding
to the given registration record | ||
Parameters | osid.type.Type | registrationRecordType | a registration record type |
Return | osid.course.registration.records.RegistrationSearchOrderRecord | the registration search order record | |
Errors | NULL_ARGUMENT | registrationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(registrationRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |