Interface PollsSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PollsSearch
extends OsidSearch

The interface for governing polls searches.

Method Summary

Modifier and Type	Method	Description
PollsSearchRecord	getPollsSearchRecord(Type pollsSearchRecordType)	Gets the polls search record corresponding to the given polls search record Type .
void	orderPollsResults(PollsSearchOrder pollsSearchOrder)	Specify an ordering to the search results.
void	searchAmongPolls(IdList pollsIds)	Execute this search among the given list of polls.

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

searchAmongPolls

void searchAmongPolls(IdList pollsIds)

Execute this search among the given list of polls.

Parameters:

pollsIds - list of polls

Throws:

NullArgumentException - pollsIds is null

Compliance:

mandatory - This method must be implemented.

orderPollsResults

void orderPollsResults(PollsSearchOrder pollsSearchOrder)

Specify an ordering to the search results.

Parameters:

pollsSearchOrder - polls search order

Throws:

NullArgumentException - pollsSearchOrder is null

UnsupportedException - pollsSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPollsSearchRecord

PollsSearchRecord getPollsSearchRecord(Type pollsSearchRecordType)
                                throws OperationFailedException

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

Parameters:

pollsSearchRecordType - a polls search record type

Returns:

the polls search record

Throws:

NullArgumentException - pollsSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pollsSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.