org.osid.voting.rules

Interface BallotConstrainerForm

All Superinterfaces:

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

public interface BallotConstrainerForm
extends OsidConstrainerForm

This is the form for creating and updating BallotConstrainers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BallotConstrainerAdminSession. 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
BallotConstrainerFormRecord	getBallotConstrainerFormRecord(Type ballotConstrainerRecordType) Gets the BallotConstrainerFormRecord corresponding to the given ballot 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

getBallotConstrainerFormRecord

BallotConstrainerFormRecord getBallotConstrainerFormRecord(Type ballotConstrainerRecordType)
                                                           throws OperationFailedException

Gets the BallotConstrainerFormRecord corresponding to the given ballot constrainer record Type.

Parameters:

ballotConstrainerRecordType - a ballot constrainer record type

Returns:

the ballot constrainer form record

Throws:

NullArgumentException - ballotConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.