Interface TermSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface TermSearch
extends OsidSearch

The search interface for governing term searches.

Method Summary

Modifier and Type	Method	Description
TermSearchRecord	getTermSearchRecord(Type termSearchRecordType)	Gets the term search record corresponding to the given term search record Type.
void	orderTermResults(TermSearchOrder termSearchOrder)	Specify an ordering to the search results.
void	searchAmongTerms(IdList termIds)	Execute this search among the given list of terms.

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

searchAmongTerms

void searchAmongTerms(IdList termIds)

Execute this search among the given list of terms.

Parameters:

termIds - list of terms

Throws:

NullArgumentException - termIds is null

Compliance:

mandatory - This method must be implemented.

orderTermResults

void orderTermResults(TermSearchOrder termSearchOrder)

Specify an ordering to the search results.

Parameters:

termSearchOrder - term search order

Throws:

NullArgumentException - termSearchOrder is null

UnsupportedException - termSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getTermSearchRecord

TermSearchRecord getTermSearchRecord(Type termSearchRecordType)
                              throws OperationFailedException

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

Parameters:

termSearchRecordType - a term search record type

Returns:

the term search record

Throws:

NullArgumentException - termSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(termSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.