Interface | osid.dictionary.EntryQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching dictionary entries. Each
method specifies an | ||
Method | matchKeyType | ||
Description |
Sets the | ||
Parameters | osid.type.Type | keyType | the key Type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | keyType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearKeyTypeTerms | ||
Description |
Clears the key type terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchKey | ||
Description |
Matches entries of this key. | ||
Parameters | object | key | the key |
osid.type.Type | keyType | the key Type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | key or keyType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearKeyTerms | ||
Description |
Clears the key terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchValueType | ||
Description |
Sets the | ||
Parameters | osid.type.Type | valueType | the value Type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | valueType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueTypeTerms | ||
Description |
Clears the value type terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchValue | ||
Description |
Sets the value in this entry. | ||
Parameters | object | value | the value |
osid.type.Type | valueType | the value Type | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | value or valueType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearValueTerms | ||
Description |
Clears the value terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDictionaryId | ||
Description |
Sets the dictionary | ||
Parameters | osid.id.Id | dictionaryId | a dictionary Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | dictionaryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDictionaryIdTerms | ||
Description |
Clears the dictionary | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDictionaryQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a dictionary query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDictionaryQuery | ||
Description |
Gets the query for a dictionary. Multiple retrievals
produce a nested boolean | ||
Return | osid.dictionary.DictionaryQuery | the dictionary query | |
Errors | UNIMPLEMENTED | supportsDictionaryQuery() is false | |
Compliance | optional | This method must be implemented if supportsDictionaryQuery()
is true. | |
Method | clearDictionaryTerms | ||
Description |
Clears the dictionary terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntryQueryRecord | ||
Description |
Gets the entry query record corresponding to the given
| ||
Parameters | osid.type.Type | entryRecordType | an entry record type |
Return | osid.dictionary.records.EntryQueryRecord | the entry query record | |
Errors | NULL_ARGUMENT | entryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(entryRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |