OSID Specifications
assessment authoring package
Version 3.1.0
assessment authoring package
Version 3.1.0
| Interface | osid.assessment.authoring.SequenceRuleSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRuleSearchOrder | ||
| Used By | osid.assessment.authoring.SequenceRuleSearchSession | ||
osid.assessment.authoring.SequenceRuleSmartBankSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByAssessmentPart | ||
| Description |
Specifies a preference for ordering the result set by the assessment part. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAssessmentPartSearchOrder | ||
| Description |
Tests if an assessment part search order is available. | ||
| Return | boolean | true if an assessment part search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssessmentPartSearchOrder | ||
| Description |
Gets the assessment order. | ||
| Return | osid.assessment.authoring.AssessmentPartSearchOrder | the assessment part search order | |
| Errors | UNIMPLEMENTED | supportsAssessmentPartSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsAssessmentPartSearchOrder() is true. | |
| Method | orderByNextAssessmentPart | ||
| Description |
Specifies a preference for ordering the result set by the assessment part. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsNextAssessmentPartSearchOrder | ||
| Description |
Tests if an assessment part search order is available. | ||
| Return | boolean | true if an assessment part search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextAssessmentPartSearchOrder | ||
| Description |
Gets the assessment order. | ||
| Return | osid.assessment.authoring.AssessmentPartSearchOrder | the assessment part search order | |
| Errors | UNIMPLEMENTED | supportsNextAssessmentPartSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsNextAssessmentPartSearchOrder() is true. | |
| Method | orderByMinimumScore | ||
| Description |
Specifies a preference for ordering the result set by the minimum score. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMaximumScore | ||
| Description |
Specifies a preference for ordering the result set by the maximum score. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCumulative | ||
| Description |
Specifies a preference for ordering the result set by the cumulative. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSequenceRuleSearchOrderRecord | ||
| Description |
Gets the sequence rule search order record
corresponding to the given sequence rule record
| ||
| Parameters | osid.type.Type | sequenceRuleRecordType | a sequence rule record type |
| Return | osid.assessment.authoring.records.SequenceRuleSearchOrderRecord | the sequence rule search order record | |
| Errors | NULL_ARGUMENT | sequenceRuleRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(sequenceRuleRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |