Interface IdiomSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface IdiomSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
IdiomQueryInspector	getIdiomQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
IdiomList	getIdioms()	Gets the idiom list resulting from a search.
IdiomSearchResultsRecord	getIdiomSearchResultsRecord(Type idiomSearchRecordType)	Gets the idiom search results record corresponding to the given idiom 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

getIdioms

IdiomList getIdioms()

Gets the idiom list resulting from a search.

Returns:

the idiom list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getIdiomQueryInspector

IdiomQueryInspector getIdiomQueryInspector()

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

Returns:

the idiom query inspector

Compliance:

mandatory - This method must be implemented.

getIdiomSearchResultsRecord

IdiomSearchResultsRecord getIdiomSearchResultsRecord(Type idiomSearchRecordType)
                                              throws OperationFailedException

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

Throws:

NullArgumentException - idiomSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(idiomSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.