org.osid.voting.rules

Interface BallotConstrainerEnabler

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface BallotConstrainerEnabler
extends OsidEnabler

A BallotConstrainerEnabler describes the rules for making a BallotConstrainer effective.

Method Summary

Methods

Modifier and Type	Method and Description
BallotConstrainerEnablerRecord	getBallotConstrainerEnablerRecord(Type ballotConstrainerEnablerRecordType) Gets the ballot constrainer enabler record corresponding to the given BallotConstrainerEnabler record Type.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

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

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getBallotConstrainerEnablerRecord

BallotConstrainerEnablerRecord getBallotConstrainerEnablerRecord(Type ballotConstrainerEnablerRecordType)
                                                                 throws OperationFailedException

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

Parameters:

ballotConstrainerEnablerRecordType - the type of ballot constrainer enabler record to retrieve

Returns:

the ballot constrainer enabler record

Throws:

NullArgumentException - ballotConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.