public interface RaceProcessorForm extends OsidProcessorForm
This is the form for creating and updating RaceProcessors.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
RaceProcessorAdminSession.
For each data element that may be set,
metadata may be examined to provide display hints or data constraints.
Modifier and Type | Method and Description |
---|---|
void |
clearMaximumWinners()
Clears the maximum winners value.
|
void |
clearMinimumPercentageToWin()
Clears the minimum percentage to win value.
|
void |
clearMinimumVotesToWin()
Clears the minimum votes to win value.
|
Metadata |
getMaximumWinnersMetadata()
Gets the metadata for the maximum winners value.
|
Metadata |
getMinimumPercentageToWinMetadata()
Gets the metadata for the minimum percentage to win value.
|
Metadata |
getMinimumPVotesToWinMetadata()
Gets the metadata for the minimum votes to win value.
|
RaceProcessorFormRecord |
getRaceProcessorFormRecord(Type raceProcessorRecordType)
Gets the
RaceProcessorFormRecord corresponding to the
given race processor record Type. |
void |
setMaximumWinners(long winners)
Sets the maximum winners.
|
void |
setMinimumPercentageToWin(long percentage)
Sets the minimum percentage to win (0-100).
|
void |
setMinimumVotesToWin(long votes)
Sets the minimum votes to win (0-100).
|
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getMaximumWinnersMetadata()
mandatory
- This method must be implemented. void setMaximumWinners(long winners)
winners
- the maximum winnersInvalidArgumentException
- winners
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMaximumWinners()
mandatory
- This method must be implemented. Metadata getMinimumPercentageToWinMetadata()
mandatory
- This method must be implemented. void setMinimumPercentageToWin(long percentage)
percentage
- the mnimum percentage to winInvalidArgumentException
- percentage
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMinimumPercentageToWin()
mandatory
- This method must be implemented. Metadata getMinimumPVotesToWinMetadata()
mandatory
- This method must be implemented. void setMinimumVotesToWin(long votes)
votes
- the mnimum votes to winInvalidArgumentException
- votes
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMinimumVotesToWin()
mandatory
- This method must be implemented. RaceProcessorFormRecord getRaceProcessorFormRecord(Type raceProcessorRecordType) throws OperationFailedException
RaceProcessorFormRecord
corresponding to the
given race processor record Type.
raceProcessorRecordType
- a race processor record typeNullArgumentException
- raceProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(raceProcessorRecordType)
is false
mandatory
- This method must be implemented.