Interface BallotSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BallotSearch
extends OsidSearch

The search interface for governing ballot searches.

Method Summary

Modifier and Type	Method	Description
BallotSearchRecord	getBallotSearchRecord(Type ballotSearchRecordType)	Gets the ballot search record corresponding to the given ballot search record Type.
void	orderBallotResults(BallotSearchOrder ballotSearchOrder)	Specify an ordering to the search results.
void	searchAmongBallots(IdList ballotIds)	Execute this search among the given list of ballots.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBallots

void searchAmongBallots(IdList ballotIds)

Execute this search among the given list of ballots.

Parameters:

ballotIds - list of ballot Ids

Throws:

NullArgumentException - ballotIds is null

Compliance:

mandatory - This method must be implemented.

orderBallotResults

void orderBallotResults(BallotSearchOrder ballotSearchOrder)

Specify an ordering to the search results.

Parameters:

ballotSearchOrder - ballot search order

Throws:

NullArgumentException - order is null

UnsupportedException - order is not of this service

Compliance:

mandatory - This method must be implemented.

getBallotSearchRecord

BallotSearchRecord getBallotSearchRecord(Type ballotSearchRecordType)
                                  throws OperationFailedException

Gets the ballot search record corresponding to the given ballot search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

ballotSearchRecordType - a ballot search record type

Returns:

the ballot search record

Throws:

NullArgumentException - ballotSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(ballotSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.