Interface VoteSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface VoteSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
VoteQueryInspector	getVoteQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
VoteList	getVotes()	Gets the vote list resulting from the search.
VoteSearchResultsRecord	getVoteSearchResultsRecord(Type voteSearchRecordType)	Gets the vote search results record corresponding to the given vote search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getVotes

VoteList getVotes()

Gets the vote list resulting from the search.

Returns:

the vote list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getVoteQueryInspector

VoteQueryInspector getVoteQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the vote query inspector

Compliance:

mandatory - This method must be implemented.

getVoteSearchResultsRecord

VoteSearchResultsRecord getVoteSearchResultsRecord(Type voteSearchRecordType)
                                            throws OperationFailedException

Gets the vote search results 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 results record

Throws:

NullArgumentException - voteSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(voteSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.