public interface DictionaryQuerySession extends OsidSession
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.
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 |
---|---|
boolean |
canSearchDictionaries()
Tests if this user can perform
Dictionary searches. |
DictionaryList |
getDictionariesByQuery(DictionaryQuery dictionaryQuery)
Gets a list of
Dictionary elements matching the given
query. |
DictionaryQuery |
getDictionaryQuery()
Gets a dictionary query.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchDictionaries()
Dictionary
searches. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. DictionaryQuery getDictionaryQuery()
mandatory
- This method must be implemented. DictionaryList getDictionariesByQuery(DictionaryQuery dictionaryQuery) throws OperationFailedException, PermissionDeniedException
Dictionary
elements matching the given
query.dictionaryQuery
- the dictionary query DictionaryList
NullArgumentException
- dictionaryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- dictionaryQuery
is not of this servicemandatory
- This method must be implemented.