Interface | osid.assessment.AssessmentTakenSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByAssessmentOffered | ||
Description |
Specifies a preference for ordering the result set by the assessment offered. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAssessmentOfferedSearchOrder | ||
Description |
Tests if an assessment search order is available. | ||
Return | boolean | true if an assessment offered search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentOfferedSearchOrder | ||
Description |
Gets an assessment offered search order. | ||
Return | osid.assessment.AssessmentOfferedSearchOrder | an assessment offered search order | |
Errors | UNIMPLEMENTED | supportsAssessmentOfferedSearchOrder() is false
| |
Compliance | optional | This method must be implemented if
supportsAssessmentOfferedSearchOrder() is true. | |
Method | orderByTaker | ||
Description |
Specifies a preference for ordering the result set by the resource. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTakerSearchOrder | ||
Description |
Tests if a resource search order is available. | ||
Return | boolean | true if a resource search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTakerSearchOrder | ||
Description |
Gets a resource search order. | ||
Return | osid.resource.ResourceSearchOrder | a resource search order | |
Errors | UNIMPLEMENTED | supportsTakerSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsTakerSearchOrder()
is true. | |
Method | orderByTakingAgent | ||
Description |
Specifies a preference for ordering the result set by the agent. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTakingAgentSearchOrder | ||
Description |
Tests if an agent search order is available. | ||
Return | boolean | true if an agent search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTakingAgentSearchOrder | ||
Description |
Gets an agent search order. | ||
Return | osid.authentication.AgentSearchOrder | an agent search order | |
Errors | UNIMPLEMENTED | supportsTakingAgentSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsTakingAgentSearchOrder()
is true. | |
Method | orderByActualStartTime | ||
Description |
Specifies a preference for ordering the result set by the assessment start time. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByCompletionTime | ||
Description |
Specifies a preference for ordering the result set by the assessment deadline. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByTimeSpent | ||
Description |
Specifies a preference for ordering the result set by the time spent. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByScoreSystem | ||
Description |
Specifies a preference for ordering the result set by the grade system. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsScoreSystemSearchOrder | ||
Description |
Tests if a grade system search order is available. | ||
Return | boolean | true if a grade system search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getScoreSystemSearchOrder | ||
Description |
Gets a grade system search order. | ||
Return | osid.grading.GradeSystemSearchOrder | a grade system search order | |
Errors | UNIMPLEMENTED | supportsScoreSystemSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsScoreSystemSearchOrder()
is true. | |
Method | orderByScore | ||
Description |
Specifies a preference for ordering the result set by the score. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByGrade | ||
Description |
Specifies a preference for ordering the result set by the grade. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradeSearchOrder | ||
Description |
Tests if a grade search order is available. | ||
Return | boolean | true if a grade search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeSearchOrder | ||
Description |
Gets a grade search order. | ||
Return | osid.grading.GradeSearchOrder | a grade search order | |
Errors | UNIMPLEMENTED | supportsGradeSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsGradeSearchOrder()
is true. | |
Method | orderByFeedback | ||
Description |
Specifies a preference for ordering the result set by the comments. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByRubric | ||
Description |
Specifies a preference for ordering the result set by the rubric assessment. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRubricSearchOrder | ||
Description |
Tests if an assessment taken search order is available. | ||
Return | boolean | true if an assessment taken search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRubricSearchOrder | ||
Description |
Gets an assessment taken search order. | ||
Return | osid.assessment.AssessmentTakenSearchOrder | a rubric assessment taken search order | |
Errors | UNIMPLEMENTED | supportsRubricSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsRubricSearchOrder()
is true. | |
Method | getAssessmentTakenSearchOrderRecord | ||
Description |
Gets the assessment taken search order record
corresponding to the given assessment record | ||
Parameters | osid.type.Type | assessmentTakenRecordType | an assessment record type |
Return | osid.assessment.records.AssessmentTakenSearchOrderRecord | the assessment taken search order record | |
Errors | NULL_ARGUMENT | assessmentTakenRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(assessmentTakenRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |