org.osid.voting

Interface BallotForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

BallotBatchForm

public interface BallotForm
extends OsidGovernatorForm, OsidTemporalForm

This is the form for creating and updating Ballots. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BallotAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearRevote() Clears the revote flag.
BallotFormRecord	getBallotFormRecord(Type candidateRecordType) Gets the BallotFormRecord corresponding to the given Ballot record Type.
Metadata	getRevoteMetadata() Gets the metadata for the revote flag.
void	setRevote(boolean revote) Sets the revote flag.

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getRevoteMetadata

Metadata getRevoteMetadata()

Gets the metadata for the revote flag.

Returns:

metadata for the revote flag

Compliance:

mandatory - This method must be implemented.

setRevote

void setRevote(boolean revote)

Sets the revote flag.

Parameters:

revote - the revote flag

Throws:

InvalidArgumentException - revote is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRevote

void clearRevote()

Clears the revote flag.

Compliance:

mandatory - This method must be implemented.

getBallotFormRecord

BallotFormRecord getBallotFormRecord(Type candidateRecordType)
                                     throws OperationFailedException

Gets the BallotFormRecord corresponding to the given Ballot record Type.

Parameters:

candidateRecordType - the ballot record type

Returns:

the ballot form record

Throws:

NullArgumentException - ballotRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotRecordType) is false

Compliance:

mandatory - This method must be implemented.