Interface VoterAllocationForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

public interface VoterAllocationForm
extends OsidObjectForm

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 Summary

Modifier and Type	Method	Description
void	clearMaxCandidates()	Clears the max candidates.
void	clearMaxVotesPerCandidate()	Clears the max votes per candidate.
void	clearTotalVotes()	Clears the total votes.
CandidateFormRecord	getCandidateFormRecord(Type candidateRecordType)	Gets the CandidateFormRecord corresponding to the given Candidate record Type.
Metadata	getMaxCandidatesMetadata()	Gets the metadata for the max candidates.
Metadata	getMaxVotesPerCandidateMetadata()	Gets the metadata for the max votes per candidate.
Metadata	getTotalVotesMetadata()	Gets the metadata for the total votes.
void	setMaxCandidates(long candidates)	Sets the max candidates.
void	setMaxVotesPerCandidate(long votes)	Sets the max votes per candidate.
void	setTotalVotes(long votes)	Sets the total votes.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

getTotalVotesMetadata

Metadata getTotalVotesMetadata()

Gets the metadata for the total votes.

Returns:

metadata for the total votes

Compliance:

mandatory - This method must be implemented.

setTotalVotes

void setTotalVotes(long votes)

Sets the total votes.

Parameters:

votes - the total votes

Throws:

InvalidArgumentException - votes is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearTotalVotes

void clearTotalVotes()

Clears the total votes.

Compliance:

mandatory - This method must be implemented.

getMaxVotesPerCandidateMetadata

Metadata getMaxVotesPerCandidateMetadata()

Gets the metadata for the max votes per candidate.

Returns:

metadata for the max votes per candidate

Compliance:

mandatory - This method must be implemented.

setMaxVotesPerCandidate

void setMaxVotesPerCandidate(long votes)

Sets the max votes per candidate.

Parameters:

votes - the max votes

Throws:

InvalidArgumentException - votes is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMaxVotesPerCandidate

void clearMaxVotesPerCandidate()

Clears the max votes per candidate.

Compliance:

mandatory - This method must be implemented.

getMaxCandidatesMetadata

Metadata getMaxCandidatesMetadata()

Gets the metadata for the max candidates.

Returns:

metadata for the max candidates

Compliance:

mandatory - This method must be implemented.

setMaxCandidates

void setMaxCandidates(long candidates)

Sets the max candidates.

Parameters:

candidates - the max candidates

Throws:

InvalidArgumentException - candidates is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMaxCandidates

void clearMaxCandidates()

Clears the max candidates.

Compliance:

mandatory - This method must be implemented.

getCandidateFormRecord

CandidateFormRecord getCandidateFormRecord(Type candidateRecordType)
                                    throws OperationFailedException

Gets the CandidateFormRecord corresponding to the given Candidate record Type.

Parameters:

candidateRecordType - the candidate record type

Returns:

the candidate form record

Throws:

NullArgumentException - candidateRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(candidateRecordType) is false

Compliance:

mandatory - This method must be implemented.