org.osid.voting

Interface RaceForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

RaceBatchForm

public interface RaceForm
extends OsidGovernatorForm, OsidSubjugateableForm

This is the form for creating and updating races. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RaceAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
RaceFormRecord	getRaceFormRecord(Type raceRecordType) Gets the RaceFormRecord corresponding to the given race record Type.

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

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getRaceFormRecord

RaceFormRecord getRaceFormRecord(Type raceRecordType)
                                 throws OperationFailedException

Gets the RaceFormRecord corresponding to the given race record Type.

Parameters:

raceRecordType - the race record type

Returns:

the race form record

Throws:

NullArgumentException - raceRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceRecordType) is false

Compliance:

mandatory - This method must be implemented.