Interface IdiomSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface IdiomSearch
extends OsidSearch

The search interface for governing idiom searches.

Method Summary

Modifier and Type	Method	Description
IdiomSearchRecord	getIdiomSearchRecord(Type idiomSearchRecordType)	Gets the idiom search record corresponding to the given idiom search record Type.
void	orderIdiomResults(IdiomSearchOrder idiomSearchOrder)	Specify an ordering to the search results.
void	searchAmongIdioms(IdList idiomIds)	Execute this search among the given list of idioms.

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

searchAmongIdioms

void searchAmongIdioms(IdList idiomIds)

Execute this search among the given list of idioms.

Parameters:

idiomIds - list of idioms

Throws:

NullArgumentException - idiomIds is null

Compliance:

mandatory - This method must be implemented.

orderIdiomResults

void orderIdiomResults(IdiomSearchOrder idiomSearchOrder)

Specify an ordering to the search results.

Parameters:

idiomSearchOrder - idiom search order

Throws:

NullArgumentException - idiomSearchOrder is null

UnsupportedException - idiomSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getIdiomSearchRecord

IdiomSearchRecord getIdiomSearchRecord(Type idiomSearchRecordType)
                                throws OperationFailedException

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

Parameters:

idiomSearchRecordType - an idiom search record type

Returns:

the idiom search record

Throws:

NullArgumentException - idiomSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(idiomSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.