Interface | osid.course.registration.ActivityRegistrationSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByRegistration | ||
Description |
Specifies a preference for ordering the result set by registration. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRegistrationSearchOrder | ||
Description |
Tests if a regiistration search order is available. | ||
Return | boolean | true if a registration search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRegistrationSearchOrder | ||
Description |
Gets the registration search order. | ||
Return | osid.course.registration.RegistrationSearchOrder | the registration search order | |
Errors | UNIMPLEMENTED | supportsRegistrationSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsRegistrationSearchOrder()
is true. | |
Method | orderByActivity | ||
Description |
Specifies a preference for ordering the result set by activity. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActivitySearchOrder | ||
Description |
Tests if an activity search order is available. | ||
Return | boolean | true if an activity search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivitySearchOrder | ||
Description |
Gets the activity search order. | ||
Return | osid.course.ActivitySearchOrder | the activity search order | |
Errors | UNIMPLEMENTED | supportsActivitySearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsActivitySearchOrder()
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 | getActivityRegistrationSearchOrderRecord | ||
Description |
Gets the activity registration search order record
corresponding to the given activity registration record
| ||
Parameters | osid.type.Type | activityRegistrationRecordType | an activity registration record type |
Return | osid.course.registration.records.ActivityRegistrationSearchOrderRecord | the activity registration search order record | |
Errors | NULL_ARGUMENT | activityRegistrationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(activityRegistrationRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |