Interface VoteSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface VoteSearch
extends OsidSearch

VoteSearch defines the interface for specifying vote search options.

Method Summary

Modifier and Type	Method	Description
VoteSearchRecord	getVoteSearchRecord(Type voteSearchRecordType)	Gets the vote search record corresponding to the given vote search record Type .
void	orderVoteResults(VoteSearchOrder voteSearchOrder)	Specify an ordering to the search results.
void	searchAmongVotes(IdList voteIds)	Execute this search among the given list of votes.

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

searchAmongVotes

void searchAmongVotes(IdList voteIds)

Execute this search among the given list of votes.

Parameters:

voteIds - a list of vote Ids

Throws:

NullArgumentException - voteIds is null

Compliance:

mandatory - This method must be implemented.

orderVoteResults

void orderVoteResults(VoteSearchOrder voteSearchOrder)

Specify an ordering to the search results.

Parameters:

voteSearchOrder - a vote search order

Throws:

NullArgumentException - voteSearchOrder is null

UnsupportedException - voteSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getVoteSearchRecord

VoteSearchRecord getVoteSearchRecord(Type voteSearchRecordType)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

voteSearchRecordType - a vote search record type

Returns:

the vote search record

Throws:

NullArgumentException - voteSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(voteSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.