org.osid.voting

Interface VoteForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

VoteBatchForm

public interface VoteForm
extends OsidRelationshipForm

This is the form for creating and updating Votes.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearVotes() Clears the votes.
VoteFormRecord	getVoteFormRecord(Type voteRecordType) Gets the VoteFormRecord record corresponding to the given vote Type.
Metadata	getVotesMetadata() Gets the metadata for the number of votes.
void	setVotes(long votes) Sets the votes.

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

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getVotesMetadata

Metadata getVotesMetadata()

Gets the metadata for the number of votes.

Returns:

metadata for the votes

Compliance:

mandatory - This method must be implemented.

setVotes

void setVotes(long votes)

Sets the votes.

Parameters:

votes - the votes

Throws:

InvalidArgumentException - votes is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearVotes

void clearVotes()

Clears the votes.

Compliance:

mandatory - This method must be implemented.

getVoteFormRecord

VoteFormRecord getVoteFormRecord(Type voteRecordType)
                                 throws OperationFailedException

Gets the VoteFormRecord record corresponding to the given vote Type.

Parameters:

voteRecordType - the vote record type

Returns:

the vote form record

Throws:

NullArgumentException - voteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(voteRecordType) is false

Compliance:

mandatory - This method must be implemented.