OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.EntryQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching dictionary entries. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchKeyType
Description

Sets the Type for querying keys of a given type.

Parametersosid.type.TypekeyTypethe key Type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT keyType is null
CompliancemandatoryThis method must be implemented.
MethodclearKeyTypeTerms
Description

Clears the key type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchKey
Description

Matches entries of this key.

Parametersobjectkeythe key
osid.type.TypekeyTypethe key Type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT key or keyType is null
CompliancemandatoryThis method must be implemented.
MethodclearKeyTerms
Description

Clears the key terms.

CompliancemandatoryThis method must be implemented.
MethodmatchValueType
Description

Sets the Type of this entry value.

Parametersosid.type.TypevalueTypethe value Type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT valueType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueTypeTerms
Description

Clears the value type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchValue
Description

Sets the value in this entry.

Parametersobjectvaluethe value
osid.type.TypevalueTypethe value Type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT value or valueType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueTerms
Description

Clears the value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDictionaryId
Description

Sets the dictionary Id for this query.

Parametersosid.id.IddictionaryIda dictionary Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT dictionaryId is null
CompliancemandatoryThis method must be implemented.
MethodclearDictionaryIdTerms
Description

Clears the dictionary Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDictionaryQuery
Description

Tests if a DictionaryQuery is available.

Returnboolean true if a dictionary query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDictionaryQuery
Description

Gets the query for a dictionary. Multiple retrievals produce a nested boolean OR term.

Returnosid.dictionary.DictionaryQuerythe dictionary query
ErrorsUNIMPLEMENTED supportsDictionaryQuery() is false
ComplianceoptionalThis method must be implemented if supportsDictionaryQuery() is true.
MethodclearDictionaryTerms
Description

Clears the dictionary terms.

CompliancemandatoryThis method must be implemented.
MethodgetEntryQueryRecord
Description

Gets the entry query record corresponding to the given Dictionary record Type. Multiple retrievale produce a nested boolean OR term.

Parametersosid.type.TypeentryRecordTypean entry record type
Returnosid.dictionary.records.EntryQueryRecordthe entry query record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.