OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.DictionarySearchSession
Implementsosid.dictionary.DictionaryQuerySession
Description

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.

MethodgetDictionarySearch
Description

Gets a dictionary search.

Returnosid.dictionary.DictionarySearchthe dictionary search
CompliancemandatoryThis method must be implemented.
MethodgetDictionarySearchOrder
Description

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

Returnosid.dictionary.DictionarySearchOrderthe dictionary search order
CompliancemandatoryThis method must be implemented.
MethodgetDictionariesBySearch
Description

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

Parametersosid.dictionary.DictionaryQuerydictionaryQuerythe dictionary search query
osid.dictionary.DictionarySearchdictionarySearchthe dictionary search
Returnosid.dictionary.DictionarySearchResultsthe returned search results
ErrorsNULL_ARGUMENT dictionaryQuery or dictionarySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED dictionarySearch or dictionaryQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDictionaryQueryFromInspector
Description

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

Parametersosid.dictionary.DictionaryQueryInspectordictionaryQueryInspectora dictionary query inspector
Returnosid.dictionary.DictionaryQuerythe dictionary query
ErrorsNULL_ARGUMENT dictionaryQueryInspector is null
UNSUPPORTED dictionaryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.