Interface TextSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface TextSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
TextQueryInspector	getTextQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
TextList	getTexts()	Gets the text list resulting from a search.
TextSearchResultsRecord	getTextSearchResultsRecord(Type textSearchRecordType)	Gets the text search results record corresponding to the given text 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

getTexts

TextList getTexts()

Gets the text list resulting from a search.

Returns:

the text list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getTextQueryInspector

TextQueryInspector getTextQueryInspector()

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

Returns:

the text query inspector

Compliance:

mandatory - This method must be implemented.

getTextSearchResultsRecord

TextSearchResultsRecord getTextSearchResultsRecord(Type textSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

textSearchRecordType - a text search record type

Returns:

the text search results record

Throws:

NullArgumentException - textSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(textSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.