Interface BallotConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BallotConstrainerSearch
extends OsidSearch

The search interface for governing ballot constrainer searches.

Method Summary

Modifier and Type	Method	Description
BallotConstrainerSearchRecord	getBallotConstrainerSearchRecord(Type ballotConstrainerSearchRecordType)	Gets the ballot constrainer search record corresponding to the given ballot constrainer search record Type .This method is used to retrieve an object implementing the requested record.
void	orderBallotConstrainerResults(BallotConstrainerSearchOrder ballotConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongBallotConstrainers(IdList pollsIds)	Execute this search among the given list of ballot constrainers.

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

searchAmongBallotConstrainers

void searchAmongBallotConstrainers(IdList pollsIds)

Execute this search among the given list of ballot constrainers.

Parameters:

pollsIds - list of ballot constrainers

Throws:

NullArgumentException - pollsIds is null

Compliance:

mandatory - This method must be implemented.

orderBallotConstrainerResults

void orderBallotConstrainerResults(BallotConstrainerSearchOrder ballotConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

ballotConstrainerSearchOrder - ballot constrainer search order

Throws:

NullArgumentException - ballotConstrainerSearchOrder is null

UnsupportedException - ballotConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBallotConstrainerSearchRecord

BallotConstrainerSearchRecord getBallotConstrainerSearchRecord(Type ballotConstrainerSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

ballotConstrainerSearchRecordType - a ballot constrainer search record type

Returns:

the ballot constrainer search record

Throws:

NullArgumentException - ballotConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.