org.osid.voting.rules

Interface RaceConstrainer

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidConstrainer, OsidObject, OsidRule

public interface RaceConstrainer
extends OsidConstrainer

A RaceConstrainer describes the rules for constraining the voting requests in a race.

Method Summary

Methods

Modifier and Type	Method and Description
RaceConstrainerRecord	getRaceConstrainerRecord(Type raceConstrainerRecordType) Gets the race constrainer record corresponding to the given RaceConstrainer record Type.

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

getRaceConstrainerRecord

RaceConstrainerRecord getRaceConstrainerRecord(Type raceConstrainerRecordType)
                                               throws OperationFailedException

Gets the race constrainer record corresponding to the given RaceConstrainer record Type. This method is used to retrieve an object implementing the requested record. The raceConstrainerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(raceConstrainerRecordType) is true .

Parameters:

raceConstrainerRecordType - the type of race constrainer record to retrieve

Returns:

the race constrainer record

Throws:

NullArgumentException - raceConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(raceConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.