Interface VoteEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface VoteEnablerSearch
extends OsidSearch

The search interface for governing vote enabler searches.

Method Summary

Modifier and Type	Method	Description
VoteEnablerSearchRecord	getVoteEnablerSearchRecord(Type voteEnablerSearchRecordType)	Gets the vote enabler search record corresponding to the given vote enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderVoteEnablerResults(VoteEnablerSearchOrder voteEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongVoteEnablers(IdList voteEnablerIds)	Execute this search among the given list of vote 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

searchAmongVoteEnablers

void searchAmongVoteEnablers(IdList voteEnablerIds)

Execute this search among the given list of vote enablers.

Parameters:

voteEnablerIds - list of vote enablers

Throws:

NullArgumentException - voteEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderVoteEnablerResults

void orderVoteEnablerResults(VoteEnablerSearchOrder voteEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

voteEnablerSearchOrder - vote enabler search order

Throws:

NullArgumentException - voteEnablerSearchOrder is null

UnsupportedException - voteEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getVoteEnablerSearchRecord

VoteEnablerSearchRecord getVoteEnablerSearchRecord(Type voteEnablerSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

voteEnablerSearchRecordType - a vote enabler search record type

Returns:

the vote enabler search record

Throws:

NullArgumentException - voteEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(voteEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.