OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceProcessorForm
Implementsosid.OsidProcessorForm
Description

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.

MethodgetMaximumWinnersMetadata
Description

Gets the metadata for the maximum winners value.

Returnosid.Metadatametadata for the maximum winners
CompliancemandatoryThis method must be implemented.
MethodsetMaximumWinners
Description

Sets the maximum winners.

Parameterscardinalwinnersthe maximum winners
ErrorsINVALID_ARGUMENT winners is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearMaximumWinners
Description

Clears the maximum winners value.

CompliancemandatoryThis method must be implemented.
MethodgetMinimumPercentageToWinMetadata
Description

Gets the metadata for the minimum percentage to win value.

Returnosid.Metadatametadata for the minimum percentage to win
CompliancemandatoryThis method must be implemented.
MethodsetMinimumPercentageToWin
Description

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

Parameterscardinalpercentagethe mnimum percentage to win
ErrorsINVALID_ARGUMENT percentage is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearMinimumPercentageToWin
Description

Clears the minimum percentage to win value.

CompliancemandatoryThis method must be implemented.
MethodgetMinimumPVotesToWinMetadata
Description

Gets the metadata for the minimum votes to win value.

Returnosid.Metadatametadata for the minimum votes to win
CompliancemandatoryThis method must be implemented.
MethodsetMinimumVotesToWin
Description

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

Parameterscardinalvotesthe mnimum votes to win
ErrorsINVALID_ARGUMENT votes is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearMinimumVotesToWin
Description

Clears the minimum votes to win value.

CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorFormRecord
Description

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

Parametersosid.type.TyperaceProcessorRecordTypea race processor record type
Returnosid.voting.rules.records.RaceProcessorFormRecordthe race processor form record
ErrorsNULL_ARGUMENT raceProcessorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(raceProcessorRecordType) is false
CompliancemandatoryThis method must be implemented.