OSID - osid.course.chronicle.AssessmentEntrySearchOrder Service Interface Definition

Interface	osid.course.chronicle.AssessmentEntrySearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.course.chronicle.AssessmentEntrySearchSession`
Used By	`osid.course.chronicle.AssessmentEntrySmartCourseCatalogSession`
Description	An interface for specifying the ordering of search results.
Method	orderByStudent
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	supportsStudentSearchOrder
Description	Tests if a resource order is available.
Return	`boolean`		`true` if a resource order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStudentSearchOrder
Description	Gets the resource order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsStudentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStudentSearchOrder()` is `true`.
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 order is available.
Return	`boolean`		`true` if an assessment 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	orderByDateCompleted
Description	Specifies a preference for ordering the result set by the completion date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByProgram
Description	Specifies a preference for ordering the result set by the program.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramSearchOrder
Description	Tests if a program order is available.
Return	`boolean`		`true` if a program order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramSearchOrder
Description	Gets the program order.
Return	`osid.course.program.ProgramSearchOrder`		the program search order
Errors	UNIMPLEMENTED		`supportsProgramSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramSearchOrder()` is `true`.
Method	orderByCourse
Description	Specifies a preference for ordering the result set by the course.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseSearchOrder
Description	Tests if a course order is available.
Return	`boolean`		`true` if a course order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseSearchOrder
Description	Gets the course order.
Return	`osid.course.CourseSearchOrder`		the course search order
Errors	UNIMPLEMENTED		`supportsCourseSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseSearchOrder()` is `true`.
Method	orderByGrade
Description	Specifies a preference for ordering the result set by the grade system for GPAs.
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 order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSearchOrder
Description	Gets the grade system search order.
Return	`osid.grading.GradeSearchOrder`		the grade search order
Errors	UNIMPLEMENTED		`supportsGradeSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradeSearchOrder()` is `true`.
Method	orderByScoreScale
Description	Specifies a preference for ordering the result set by the grade system for scores.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsScoreScaleSearchOrder
Description	Tests if a grade system order is available.
Return	`boolean`		`true` if a grade system order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScoreScaleSearchOrder
Description	Gets the grade system order.
Return	`osid.grading.GradeSystemSearchOrder`		the grade system search order
Errors	UNIMPLEMENTED		`supportsScoreScaleSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScoreScaleSearchOrder()` 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	getAssessmentEntrySearchOrderRecord
Description	Gets the assessment search order record corresponding to the given assessment entry record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`assessmentEntryRecordType`	an assessment entry record type
Return	`osid.course.chronicle.records.AssessmentEntrySearchOrderRecord`		the assessment entry search order record
Errors	NULL_ARGUMENT		`assessmentEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.