OSID - osid.offering.ResultSearchOrder Service Interface Definition

Interface	osid.offering.ResultSearchOrder
Implements	`osid.OsidObjectSearchOrder`
	`osid.OsidTemporalSearchOrder`
	`osid.OsidSubjugateableSearchOrder`
Used By	`osid.offering.ResultSearchSession`
Used By	`osid.offering.ResultSmartCatalogueSession`
Description	An interface for specifying the ordering of search results.
Method	orderByParticipant
Description	Specifies a preference for ordering the result set by the participant.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantSearchOrder
Description	Tests if a participant search order is available.
Return	`boolean`		`true` if a participant search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantSearchOrder
Description	Gets the participant search order.
Return	`osid.offering.ParticipantSearchOrder`		the participant search order
Errors	UNIMPLEMENTED		`supportsParticipantSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParticipantSearchOrder()` is `true`.
Method	orderByGrade
Description	Specifies a preference for ordering the result set by the commitment.
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 the grade 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	orderByValue
Description	Specifies a preference for ordering the result set by the value.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResultSearchOrderRecord
Description	Gets the result search order record corresponding to the given result record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`resultRecordType`	a result record type
Return	`osid.offering.records.ResultSearchOrderRecord`		the result search order record
Errors	NULL_ARGUMENT		`resultRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(resultRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.