org.osid.voting

Interface PollsSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PollsSearch
extends OsidSearch

The interface for governing polls searches.

Method Summary

Methods

Modifier and Type	Method and 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 org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

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.