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.

Like all OsidForms, VoterAllocationForm is stateful and must not be accessed by multiple processing threads.

  • 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.