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

Interface	osid.course.chronicle.AwardEntrySearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
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	orderByAward
Description	Specifies a preference for ordering the result set by the award.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardSearchOrder
Description	Tests if an award order is available.
Return	`boolean`		`true` if an award order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAwardSearchOrder
Description	Gets the award order.
Return	`osid.recognition.AwardSearchOrder`		the award search order
Errors	UNIMPLEMENTED		`supportsAwardSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAwardSearchOrder()` is `true.`
Method	orderByDateAwarded
Description	Specifies a preference for ordering the result set by the award 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	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	getAwardEntrySearchOrderRecord
Description	Gets the award search order record corresponding to the given award entry record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`awardEntryRecordType`	an award entry record type
Return	`osid.course.chronicle.records.AwardEntrySearchOrderRecord`		the award entry search order record
Errors	NULL_ARGUMENT		`awardEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(awardEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.