OSID - osid.voting.Vote Service Interface Definition

Interface	osid.voting.Vote
Implements	`osid.OsidRelationship`
Description	A `Vote` is a relationship between a `Candidate` and a `voter.`
Method	getCandidateId
Description	Gets the candidate `Id.`
Return	`osid.id.Id`		a candidate `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCandidate
Description	Gets the `Candidate.`
Return	`osid.voting.Candidate`		the candidate
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getVoterId
Description	Gets the resource `Id` of the voter.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getVoter
Description	Gets the resource of the voter.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getVotingAgentId
Description	Gets the agent `Id` of the voter.
Return	`osid.id.Id`		the agent `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getVotingAgent
Description	Gets the agent of the voter.
Return	`osid.authentication.Agent`		the agent
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getVotes
Description	Gets the number of votes cast for this candidate.
Return	`integer`		the number of votes cast
Compliance	`mandatory`		This method must be implemented.
Method	getVoteRecord
Description	Gets the vote record corresponding to the given `Vote` record `Type.` This method is used to retrieve an object implementing the requested record. The `voteRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(voteRecordType)` is `true` .
Parameters	`osid.type.Type`	`voteRecordType`	the type of the record to retrieve
Return	`osid.voting.records.VoteRecord`		the vote 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.