Interface RaceProcessorForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidProcessorForm, OsidRuleForm, Suppliable

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.

Method Summary

Modifier and Type	Method	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).

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getMaximumWinnersMetadata

Metadata getMaximumWinnersMetadata()

Gets the metadata for the maximum winners value.

Returns:

metadata for the maximum winners

Compliance:

mandatory - This method must be implemented.

setMaximumWinners

void setMaximumWinners(long winners)

Sets the maximum winners.

Parameters:

winners - the maximum winners

Throws:

InvalidArgumentException - winners is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMaximumWinners

void clearMaximumWinners()

Clears the maximum winners value.

Compliance:

mandatory - This method must be implemented.

getMinimumPercentageToWinMetadata

Metadata getMinimumPercentageToWinMetadata()

Gets the metadata for the minimum percentage to win value.

Returns:

metadata for the minimum percentage to win

Compliance:

mandatory - This method must be implemented.

setMinimumPercentageToWin

void setMinimumPercentageToWin(long percentage)

Sets the minimum percentage to win (0-100).

Parameters:

percentage - the mnimum percentage to win

Throws:

InvalidArgumentException - percentage is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMinimumPercentageToWin

void clearMinimumPercentageToWin()

Clears the minimum percentage to win value.

Compliance:

mandatory - This method must be implemented.

getMinimumPVotesToWinMetadata

Metadata getMinimumPVotesToWinMetadata()

Gets the metadata for the minimum votes to win value.

Returns:

metadata for the minimum votes to win

Compliance:

mandatory - This method must be implemented.

setMinimumVotesToWin

void setMinimumVotesToWin(long votes)

Sets the minimum votes to win (0-100).

Parameters:

votes - the mnimum votes to win

Throws:

InvalidArgumentException - votes is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMinimumVotesToWin

void clearMinimumVotesToWin()

Clears the minimum votes to win value.

Compliance:

mandatory - This method must be implemented.

getRaceProcessorFormRecord

RaceProcessorFormRecord getRaceProcessorFormRecord(Type raceProcessorRecordType)
                                            throws OperationFailedException

Gets the RaceProcessorFormRecord corresponding to the given race processor record Type .

Parameters:

raceProcessorRecordType - a race processor record type

Returns:

the race processor form record

Throws:

NullArgumentException - raceProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.