Interface PollsSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PollsSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PollsList	getPolls()	Gets the polls list resulting from the search.
PollsQueryInspector	getPollsQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
PollsSearchResultsRecord	getPollsSearchResultsRecord(Type pollsSearchRecordType)	Gets the polls search results record corresponding to the given polls 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

getPolls

PollsList getPolls()

Gets the polls list resulting from the search.

Returns:

the polls list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getPollsQueryInspector

PollsQueryInspector getPollsQueryInspector()

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

Returns:

the polls query inspector

Compliance:

mandatory - This method must be implemented.

getPollsSearchResultsRecord

PollsSearchResultsRecord getPollsSearchResultsRecord(Type pollsSearchRecordType)
                                              throws OperationFailedException

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

Throws:

NullArgumentException - pollsSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pollsSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.