OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.EntryQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among entries. The search query is constructed using the EntryQuery.

MethodgetDictionaryId
Description

Gets the Dictionary Id associated with this session.

Returnosid.id.Idthe Dictionary Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDictionary
Description

Gets the Dictionary associated with this session.

Returnosid.dictionary.Dictionarythe Dictionary associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchEntries
Description

Tests if this user can perform dictionary entry 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.
MethoduseFederatedDictionaryView
Description

Federates the view for methods in this session. A federated view will include entries from descendant dictionaries in the catalog hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedDictionaryView
Description

Isolates the view for methods in this session. An isolated view restricts notifications for entries to this dictionary only.

CompliancemandatoryThis method is must be implemented.
MethodgetEntryQuery
Description

Gets an entry query.

Returnosid.dictionary.EntryQuerythe entry query
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByQuery
Description

Gets a list of Entry elements matching the given search.

Parametersosid.dictionary.EntryQueryentryQuerythe entry query
Returnosid.dictionary.EntryListthe returned EntryList
ErrorsNULL_ARGUMENT entryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED entryQuery is not of this service
CompliancemandatoryThis method must be implemented.