org.osid.dictionary

Interface DictionarySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DictionarySearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
DictionaryList	getDictionaries() Gets the dictionary list resulting from the search.
DictionaryQueryInspector	getDictionaryQueryInspector() Gets the inspector for the query to examine the terms used in the search.
DictionarySearchResultsRecord	getDictionarySearchResultsRecord(Type dictionarySearchRecordType) Gets the dictionary search results record corresponding to the given dictionary 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

getDictionaries

DictionaryList getDictionaries()

Gets the dictionary list resulting from the search.

Returns:

the dictionary list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getDictionaryQueryInspector

DictionaryQueryInspector getDictionaryQueryInspector()

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

Returns:

the dictionary query inspector

Compliance:

mandatory - This method must be implemented.

getDictionarySearchResultsRecord

DictionarySearchResultsRecord getDictionarySearchResultsRecord(Type dictionarySearchRecordType)
                                                               throws OperationFailedException

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

Parameters:

dictionarySearchRecordType - a dictionary search record type

Returns:

the dictionary search results record

Throws:

NullArgumentException - dictionarySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dictionarySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.