OSID - osid.dictionary.EntryQuery Service Interface Definition

Interface	osid.dictionary.EntryQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.dictionary.DictionaryQuery`
	`osid.dictionary.EntryQuerySession`
	`osid.dictionary.EntrySearchSession`
	`osid.dictionary.EntrySmartDictionarySession`
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`.
Method	matchKeyType
Description	Sets the `Type` for querying keys of a given type.
Parameters	`osid.type.Type`	`keyType`	the key `Type`
Parameters	`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 `Type` of this entry value.
Parameters	`osid.type.Type`	`valueType`	the value `Type`
Parameters	`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 `Id` for this query.
Parameters	`osid.id.Id`	`dictionaryId`	a dictionary `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionaryQuery
Description	Tests if a `DictionaryQuery` is available.
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 `OR` term.
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 `Dictionary` record `Type`. Multiple retrievale produce a nested boolean `OR` term.
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.