Interface BallotConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BallotConstrainerEnablerSearch
extends OsidSearch

The search interface for governing ballot constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
BallotConstrainerEnablerSearchRecord	getBallotConstrainerEnablerSearchRecord(Type ballotConstrainerEnablerSearchRecordType)	Gets the ballot constrainer enabler search record corresponding to the given ballot constrainer enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderBallotConstrainerEnablerResults(BallotConstrainerEnablerSearchOrder ballotConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongBallotConstrainerEnablers(IdList ballotConstrainerEnablerIds)	Execute this search among the given list of ballot constrainer enablers.

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

searchAmongBallotConstrainerEnablers

void searchAmongBallotConstrainerEnablers(IdList ballotConstrainerEnablerIds)

Execute this search among the given list of ballot constrainer enablers.

Parameters:

ballotConstrainerEnablerIds - list of ballot constrainer enablers

Throws:

NullArgumentException - ballotConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderBallotConstrainerEnablerResults

void orderBallotConstrainerEnablerResults(BallotConstrainerEnablerSearchOrder ballotConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

ballotConstrainerEnablerSearchOrder - ballot constrainer enabler search order

Throws:

NullArgumentException - ballotConstrainerEnablerSearchOrder is null

UnsupportedException - ballotConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBallotConstrainerEnablerSearchRecord

BallotConstrainerEnablerSearchRecord getBallotConstrainerEnablerSearchRecord(Type ballotConstrainerEnablerSearchRecordType)
                                                                      throws OperationFailedException

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

Parameters:

ballotConstrainerEnablerSearchRecordType - a ballot constrainer enabler search record type

Returns:

the ballot constrainer enabler search record

Throws:

NullArgumentException - ballotConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(ballotConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.