OSID - osid.voting.VoterAllocationForm Service Interface Definition

Interface	osid.voting.VoterAllocationForm
Implements	`osid.OsidObjectForm`
Used By	`osid.voting.VoterAllocationAdminSession`
Description	This is the form for creating and updating `VoterAllocations` . Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `VoterAllocationAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTotalVotesMetadata
Description	Gets the metadata for the total votes.
Return	`osid.Metadata`		metadata for the total votes
Compliance	`mandatory`		This method must be implemented.
Method	setTotalVotes
Description	Sets the total votes.
Parameters	`cardinal`	`votes`	the total votes
Errors	INVALID_ARGUMENT		`votes` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearTotalVotes
Description	Clears the total votes.
Compliance	`mandatory`		This method must be implemented.
Method	getMaxVotesPerCandidateMetadata
Description	Gets the metadata for the max votes per candidate.
Return	`osid.Metadata`		metadata for the max votes per candidate
Compliance	`mandatory`		This method must be implemented.
Method	setMaxVotesPerCandidate
Description	Sets the max votes per candidate.
Parameters	`cardinal`	`votes`	the max votes
Errors	INVALID_ARGUMENT		`votes` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMaxVotesPerCandidate
Description	Clears the max votes per candidate.
Compliance	`mandatory`		This method must be implemented.
Method	getMaxCandidatesMetadata
Description	Gets the metadata for the max candidates.
Return	`osid.Metadata`		metadata for the max candidates
Compliance	`mandatory`		This method must be implemented.
Method	setMaxCandidates
Description	Sets the max candidates.
Parameters	`cardinal`	`candidates`	the max candidates
Errors	INVALID_ARGUMENT		`candidates` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMaxCandidates
Description	Clears the max candidates.
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateFormRecord
Description	Gets the `CandidateFormRecord` corresponding to the given `Candidate` record `Type` .
Parameters	`osid.type.Type`	`candidateRecordType`	the candidate record type
Return	`osid.voting.records.CandidateFormRecord`		the candidate form 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.