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.
Modifier and Type | Method and 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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getTotalVotesMetadata()
mandatory
- This method must be implemented. void setTotalVotes(long votes)
votes
- the total votesInvalidArgumentException
- votes
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearTotalVotes()
mandatory
- This method must be implemented. Metadata getMaxVotesPerCandidateMetadata()
mandatory
- This method must be implemented. void setMaxVotesPerCandidate(long votes)
votes
- the max votesInvalidArgumentException
- votes
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMaxVotesPerCandidate()
mandatory
- This method must be implemented. Metadata getMaxCandidatesMetadata()
mandatory
- This method must be implemented. void setMaxCandidates(long candidates)
candidates
- the max candidatesInvalidArgumentException
- candidates
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMaxCandidates()
mandatory
- This method must be implemented. CandidateFormRecord getCandidateFormRecord(Type candidateRecordType) throws OperationFailedException
CandidateFormRecord
corresponding to the given
Candidate
record Type.
candidateRecordType
- the candidate record typeNullArgumentException
- candidateRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(candidateRecordType)
is false
mandatory
- This method must be implemented.