org.osid.dictionary

Interface DictionarySearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DictionaryQuerySession, OsidSession

public interface DictionarySearchSession
extends DictionaryQuerySession

This session provides methods for searching Dictionary objects. The search query is constructed using the DictionaryQuery. The dictionary record Type also specifies the record for the dictionary query.

getDictionariesByQuery() is the basic search method and returns a list of Dictionary elements. A more advanced search may be performed with getDictionaresBySearch(). It accepts a DictionarySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDictionariesBySearch() returns a DictionarySearchResults that can be used to access the resulting DictionaryList or be used to perform a search within the result set through DictionarySearch.

Dictionaries may have a query record indicated by their respective record types. The query record is accessed via the DictionaryQuery.

Method Summary

Methods

Modifier and Type	Method and Description
DictionarySearchResults	getDictionariesBySearch(DictionaryQuery dictionaryQuery, DictionarySearch dictionarySearch) Gets the search results matching the given search query using the given search.
DictionaryQuery	getDictionaryQueryFromInspector(DictionaryQueryInspector dictionaryQueryInspector) Gets a dictionary query from an inspector.
DictionarySearch	getDictionarySearch() Gets a dictionary search.
DictionarySearchOrder	getDictionarySearchOrder() Gets a dictionary search order.

Methods inherited from interface org.osid.dictionary.DictionaryQuerySession

canSearchDictionaries, getDictionariesByQuery, getDictionaryQuery

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDictionarySearch

DictionarySearch getDictionarySearch()

Gets a dictionary search.

Returns:

the dictionary search

Compliance:

mandatory - This method must be implemented.

getDictionarySearchOrder

DictionarySearchOrder getDictionarySearchOrder()

Gets a dictionary search order. The DictionarySearchOrder is supplied to a DictionarySearch to specify the ordering of results.

Returns:

the dictionary search order

Compliance:

mandatory - This method must be implemented.

getDictionariesBySearch

DictionarySearchResults getDictionariesBySearch(DictionaryQuery dictionaryQuery,
                                              DictionarySearch dictionarySearch)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

dictionaryQuery - the dictionary search query

dictionarySearch - the dictionary search

Returns:

the returned search results

Throws:

NullArgumentException - dictionaryQuery or dictionarySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - dictionarySearch or dictionaryQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getDictionaryQueryFromInspector

DictionaryQuery getDictionaryQueryFromInspector(DictionaryQueryInspector dictionaryQueryInspector)

Gets a dictionary query from an inspector. The inspector is available from a DictionarySearchResults.

Parameters:

dictionaryQueryInspector - a dictionary query inspector

Returns:

the dictionary query

Throws:

NullArgumentException - dictionaryQueryInspector is null

UnsupportedException - dictionaryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.