OSID - osid.voting.VoteSearchOrder Service Interface Definition

Interface	osid.voting.VoteSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.voting.VoteSearchSession`
Used By	`osid.voting.VoteSmartPollsSession`
Description	An interface for specifying the ordering of search results.
Method	orderByCandidate
Description	Specified a preference for ordering results by the candidate.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateSearchOrder
Description	Tests if a `CandidateSearchOrder` is available.
Return	`boolean`		`true` if a candidate search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateSearchOrder
Description	Gets the search order interface for a candidate.
Return	`osid.voting.CandidateSearchOrder`		the candidate search order
Errors	UNIMPLEMENTED		`supportsCandidateSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCandidateSearchOrder()` is `true` .
Method	orderByVoter
Description	Specified a preference for ordering results by the voter.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsVoterSearchOrder
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	getVoterSearchOrder
Description	Gets the search order for a resource.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsVoterSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVoterSearchOrder()` is `true` .
Method	orderByVotingAgent
Description	Specified a preference for ordering results by the voteing agent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsVotingAgentSearchOrder
Description	Tests if an `AgentSearchOrder` is available.
Return	`boolean`		`true` if an agent search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getVotingAgentSearchOrder
Description	Gets the search order for an agent.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	UNIMPLEMENTED		`supportsVotingAgentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsVotingAgentSearchOrder()` is `true` .
Method	orderByVotes
Description	Specified a preference for ordering results by the number of votes.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getVoteSearchOrderRecord
Description	Gets the vote search order record corresponding to the given vote record `Type` . Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`voteRecordType`	a vote record type
Return	`osid.voting.records.VoteSearchOrderRecord`		the vote search order record
Errors	NULL_ARGUMENT		`voteRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(VoteRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.