OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.DictionaryQuerySession
Implementsosid.OsidSession
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.

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

MethodcanSearchDictionaries
Description

Tests if this user can perform 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.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDictionaryQuery
Description

Gets a dictionary query.

Returnosid.dictionary.DictionaryQuerythe dictionary query
CompliancemandatoryThis method must be implemented.
MethodgetDictionariesByQuery
Description

Gets a list of Dictionary elements matching the given query.

Parametersosid.dictionary.DictionaryQuerydictionaryQuerythe dictionary query
Returnosid.dictionary.DictionaryListthe returned DictionaryList
ErrorsNULL_ARGUMENT dictionaryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED dictionaryQuery is not of this service
CompliancemandatoryThis method must be implemented.