Interface Ballot

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Temporal
public interface Ballot extends OsidGovernator, Temporal

A Ballot represents a set of races.

  • Method Details

    • getCommissionerIds

      IdList getCommissionerIds()
      Gets the Ids of the commissioners.
      Returns:
      the commissioner Ids
      Compliance:
      mandatory - This method must be implemented.

    • getCommissioners

      ResourceList getCommissioners() throws OperationFailedException
      Gets the commissioners.
      Returns:
      the commissioners
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • canRevote

      boolean canRevote()
      Tests if races on this ballot can be modified before the election ends.
      Returns:
      true if votes can be modified, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getBallotRecord

      BallotRecord getBallotRecord(Type ballotRecordType) throws OperationFailedException
      Gets the ballot record corresponding to the given Ballot record Type .This method is used to retrieve an object implementing the requested record. The ballotRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(ballotRecordType) is true .
      Parameters:
      ballotRecordType - the ballot record type
      Returns:
      the ballot record
      Throws:
      NullArgumentException - ballotRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(ballotRecordType) is false
      Compliance:
      mandatory - This method must be implemented.