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.
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.
|
canSearchDictionaries, getDictionariesByQuery, getDictionaryQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DictionarySearch getDictionarySearch()
mandatory
- This method must be implemented. DictionarySearchOrder getDictionarySearchOrder()
DictionarySearchOrder
is supplied to a DictionarySearch
to specify
the ordering of results.mandatory
- This method must be implemented. DictionarySearchResults getDictionariesBySearch(DictionaryQuery dictionaryQuery, DictionarySearch dictionarySearch) throws OperationFailedException, PermissionDeniedException
dictionaryQuery
- the dictionary search querydictionarySearch
- the dictionary searchNullArgumentException
- dictionaryQuery
or dictionarySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- dictionarySearch
or dictionaryQuery
is not of this servicemandatory
- This method must be implemented. DictionaryQuery getDictionaryQueryFromInspector(DictionaryQueryInspector dictionaryQueryInspector)
DictionarySearchResults.
dictionaryQueryInspector
- a dictionary query inspectorNullArgumentException
- dictionaryQueryInspector
is null
UnsupportedException
- dictionaryQueryInspector
is not of this servicemandatory
- This method must be implemented.