public interface VoteForm extends OsidRelationshipForm
This is the form for creating and updating Votes.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getVotesMetadata()
mandatory
- This method must be implemented. void setVotes(long votes)
votes
- the votesInvalidArgumentException
- votes
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearVotes()
mandatory
- This method must be implemented. VoteFormRecord getVoteFormRecord(Type voteRecordType) throws OperationFailedException
VoteFormRecord
record corresponding to the
given vote Type.
voteRecordType
- the vote record typeNullArgumentException
- voteRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(voteRecordType)
is false
mandatory
- This method must be implemented.