org.osid.voting

Interface BallotSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface BallotSearchOrder
extends OsidGovernatorSearchOrder, OsidTemporalSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BallotSearchOrderRecord	getBallotSearchOrderRecord(Type ballotRecordType) Gets the ballot search order record corresponding to the given ballot record Type.
void	orderByRevote(SearchOrderStyle style) Orders by the revote flag.

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

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByRevote

void orderByRevote(SearchOrderStyle style)

Orders by the revote flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getBallotSearchOrderRecord

BallotSearchOrderRecord getBallotSearchOrderRecord(Type ballotRecordType)
                                                   throws OperationFailedException

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

Parameters:

ballotRecordType - a ballot record type

Returns:

the ballot search order record

Throws:

NullArgumentException - ballotRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotRecordType) is false

Compliance:

mandatory - This method must be implemented.