org.osid.voting.rules

Interface BallotConstrainer

All Superinterfaces:

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

public interface BallotConstrainer
extends OsidConstrainer

A BallotConstrainer describes the rules for constraining the resources in a ballot.

Method Summary

Methods

Modifier and Type	Method and Description
BallotConstrainerRecord	getBallotConstrainerRecord(Type ballotConstrainerRecordType) Gets the ballot constrainer record corresponding to the given BallotConstrainer 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

getBallotConstrainerRecord

BallotConstrainerRecord getBallotConstrainerRecord(Type ballotConstrainerRecordType)
                                                   throws OperationFailedException

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

Parameters:

ballotConstrainerRecordType - the type of ballot constrainer record to retrieve

Returns:

the ballot constrainer record

Throws:

NullArgumentException - ballotConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.