org.osid.voting.rules

Interface BallotConstrainerSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidConstrainerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface BallotConstrainerSearchOrder
extends OsidConstrainerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BallotConstrainerSearchOrderRecord	getBallotConstrainerSearchOrderRecord(Type ballotConstrainerRecordType) Gets the ballot constrainer search order record corresponding to the given ballot constrainer record Type.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

getBallotConstrainerSearchOrderRecord

BallotConstrainerSearchOrderRecord getBallotConstrainerSearchOrderRecord(Type ballotConstrainerRecordType)
                                                                         throws OperationFailedException

Gets the ballot constrainer search order record corresponding to the given ballot constrainer record Type. Multiple retrievals return the same underlying object.

Parameters:

ballotConstrainerRecordType - a ballot constrainer record type

Returns:

the ballot constrainer search order record

Throws:

NullArgumentException - ballotConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.