Interface | osid.assessment.authoring.AssessmentPartSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidContainableSearchOrder | |||
osid.OsidOperableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByAssessment | ||
Description |
Specifies a preference for ordering the result set by the assessment. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAssessmentSearchOrder | ||
Description |
Tests if an assessment search order is available. | ||
Return | boolean | true if an assessment search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentSearchOrder | ||
Description |
Gets the assessment order. | ||
Return | osid.assessment.AssessmentSearchOrder | the assessment search order | |
Errors | UNIMPLEMENTED | supportsAssessmentSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsAssessmentSearchOrder()
is true. | |
Method | orderBySection | ||
Description |
Specifies a preference for ordering the result set by the section. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByWeight | ||
Description |
Specifies a preference for ordering the result set by the weight. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByAllocatedTime | ||
Description |
Specifies a preference for ordering the result set by the allocated time. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentPartSearchOrderRecord | ||
Description |
Gets the assessment part search order record
corresponding to the given assessment part record | ||
Parameters | osid.type.Type | assessmentPartRecordType | an assessment part record type |
Return | osid.assessment.authoring.records.AssessmentPartSearchOrderRecord | the assessment part search order record | |
Errors | NULL_ARGUMENT | assessmentPartRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(assessmentPartRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |