Interface TextSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface TextSearch
extends OsidSearch

The search interface for governing text searches.

Method Summary

Modifier and Type	Method	Description
TextSearchRecord	getTextSearchRecord(Type textSearchRecordType)	Gets the text search record corresponding to the given text search record Type.
void	orderTextResults(TextSearchOrder textSearchOrder)	Specify an ordering to the search results.
void	searchAmongTexts(IdList textIds)	Execute this search among the given list of texts.

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

searchAmongTexts

void searchAmongTexts(IdList textIds)

Execute this search among the given list of texts.

Parameters:

textIds - list of texts

Throws:

NullArgumentException - textIds is null

Compliance:

mandatory - This method must be implemented.

orderTextResults

void orderTextResults(TextSearchOrder textSearchOrder)

Specify an ordering to the search results.

Parameters:

textSearchOrder - text search order

Throws:

NullArgumentException - textSearchOrder is null

UnsupportedException - textSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getTextSearchRecord

TextSearchRecord getTextSearchRecord(Type textSearchRecordType)
                              throws OperationFailedException

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

Throws:

NullArgumentException - textSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(textSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.