Interface DictionarySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DictionarySearch
extends OsidSearch

This interface defines search options.

Method Summary

Modifier and Type	Method	Description
DictionarySearchRecord	getDictionarySearchRecord(Type dictionarySearchRecordType)	Gets the dictionary search record corresponding to the given dictionary search record Type .This method is used to retrieve an object implementing the requested record interface.
void	orderDictionaryResults(DictionarySearchOrder dictionarySearchOrder)	Specify an ordering to the search results.
void	searchAmongDictionaries(IdList dictionaryIds)	Execute this search among the given list of dictionaries.

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

searchAmongDictionaries

void searchAmongDictionaries(IdList dictionaryIds)

Execute this search among the given list of dictionaries.

Parameters:

dictionaryIds - list of dictionaries

Throws:

NullArgumentException - dictionaryIds is null

Compliance:

mandatory - This method must be implemented.

orderDictionaryResults

void orderDictionaryResults(DictionarySearchOrder dictionarySearchOrder)

Specify an ordering to the search results.

Parameters:

dictionarySearchOrder - dictionary search order

Throws:

NullArgumentException - dictionarySearchOrder is null

UnsupportedException - dictionarySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDictionarySearchRecord

DictionarySearchRecord getDictionarySearchRecord(Type dictionarySearchRecordType)
                                          throws OperationFailedException

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

Parameters:

dictionarySearchRecordType - a dictionary search record type

Returns:

the dictionary search record

Throws:

NullArgumentException - dictionarySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dictionarySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.