org.osid.course

Interface TermSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface TermSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
TermQueryInspector	getTermQueryInspector() Gets the inspector for the query to examine the terms used in the search.
TermList	getTerms() Gets the term list resulting from a search.
TermSearchResultsRecord	getTermSearchResultsRecord(Type termSearchRecordType) Gets the term search results record corresponding to the given term search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getTerms

TermList getTerms()

Gets the term list resulting from a search.

Returns:

the term list

Throws:

IllegalStateException - the term list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getTermQueryInspector

TermQueryInspector getTermQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getTermSearchResultsRecord

TermSearchResultsRecord getTermSearchResultsRecord(Type termSearchRecordType)
                                                   throws OperationFailedException

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

Throws:

NullArgumentException - termSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(termSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.