org.osid.voting.rules

Interface RaceConstrainerForm

All Superinterfaces:

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

public interface RaceConstrainerForm
extends OsidConstrainerForm

This is the form for creating and updating RaceConstrainers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RaceConstrainerAdminSession. 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
RaceConstrainerFormRecord	getRaceConstrainerFormRecord(Type raceConstrainerRecordType) Gets the RaceConstrainerFormRecord corresponding to the given race constrainer record Type.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

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

Method Detail

getRaceConstrainerFormRecord

RaceConstrainerFormRecord getRaceConstrainerFormRecord(Type raceConstrainerRecordType)
                                                       throws OperationFailedException

Gets the RaceConstrainerFormRecord corresponding to the given race constrainer record Type.

Parameters:

raceConstrainerRecordType - a race constrainer record type

Returns:

the race constrainer form record

Throws:

NullArgumentException - raceConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.