org.osid.voting

Interface Ballot

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Sourceable, Temporal

public interface Ballot
extends OsidGovernator, Temporal

A Ballot represents a set of races.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRevote() Tests if races on this ballot can be modified before the election ends.
BallotRecord	getBallotRecord(Type ballotRecordType) Gets the ballot record corresponding to the given Ballot record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

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.