OSID - osid.voting.CandidateSearchOrder Service Interface Definition

Interface	osid.voting.CandidateSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.voting.CandidateSearchSession`
	`osid.voting.CandidateSmartPollsSession`
	`osid.voting.VoteSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByRace
Description	Specified a preference for ordering results by the race.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceSearchOrder
Description	Tests if a `RaceSearchOrder` is available.
Return	`boolean`		`true` if a race search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRaceSearchOrder
Description	Gets the search order for a race.
Return	`osid.voting.RaceSearchOrder`		the race search order
Errors	UNIMPLEMENTED		`supportsRaceSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRaceSearchOrder()` is `true` .
Method	orderByResource
Description	Specified a preference for ordering results by the assoicated resource.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceSearchOrder
Description	Tests if a `ResourceSearchOrder` is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceSearchOrder
Description	Gets the search order for the associated resource.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsResourceSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceSearchOrder()` is `true` .
Method	getCandidateSearchOrderRecord
Description	Gets the candidate search order record corresponding to the given candidate record `Type` .Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`candidateRecordType`	a candidate record type
Return	`osid.voting.records.CandidateSearchOrderRecord`		the candidate search order record
Errors	NULL_ARGUMENT		`candidateRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(candidateRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.