OSID - osid.dictionary.DictionaryQuery Service Interface Definition

Interface	osid.dictionary.DictionaryQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.dictionary.DictionaryQuery`
	`osid.dictionary.DictionaryQuerySession`
	`osid.dictionary.DictionarySearchSession`
	`osid.dictionary.EntryQuery`
Description	This is the query for searching dictionaries. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchEntryId
Description	Sets the entry `Id`.
Parameters	`osid.id.Id`	`entryId`	an entry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`entryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryIdTerms
Description	Clears the entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryQuery
Description	Tests if an `EntryQuery` is available.
Return	`boolean`		`true` if an entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryQuery
Description	Gets the query for an entry. Multiple retrievale produce a nested boolean `OR` term.
Return	`osid.dictionary.EntryQuery`		the entry query
Errors	UNIMPLEMENTED		`supportsEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryQuery()` is `true`.
Method	matchAnyEntry
Description	Matches dictionaries with any entry.
Parameters	`boolean`	`match`	`true` to match dictionaries with any entry, `false` to match dictionaries with no entry
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryTerms
Description	Clears the entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorDictionaryId
Description	Sets the dictionary `Id` for to match dictionaries in which the specified dictionary is an acestor.
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	clearAncestorDictionaryIdTerms
Description	Clears the ancestor dictionary `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorDictionaryQuery
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	getAncestorDictionaryQuery
Description	Gets the query for an ancestor dictionary. Multiple retrievals produce a nested `OR` term.
Return	`osid.dictionary.DictionaryQuery`		the dictionary query
Errors	UNIMPLEMENTED		`supportsAncestorDictionaryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorDictionaryQuery()` is `true`.
Method	matchAnyAncestorDictionary
Description	Matches a dictionary that has any ancestor.
Parameters	`boolean`	`match`	`true` to match dictionaries with any ancestor dictionaries, `false` to match root dictionaries
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorDictionaryTerms
Description	Clears the ancestor dictionary terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantDictionaryId
Description	Sets the dictionary `Id` for to match dictionaries in which the specified dictionary is a descendant.
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	clearDescendantDictionaryIdTerms
Description	Clears the dictionary `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantDictionaryQuery
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	getDescendantDictionaryQuery
Description	Gets the query for a descendant dictioonary. Multiple retrievals produce a nested `OR` term.
Return	`osid.dictionary.DictionaryQuery`		the dictionary query
Errors	UNIMPLEMENTED		`supportsDescendantDictionaryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantDictionaryQuery()` is `true`.
Method	matchAnyDescendantDictionary
Description	Matches a dictionary that has any descendant.
Parameters	`boolean`	`match`	`true` to match dictionaries with any descendant dictionaries, `false` to match leaf dictionaries
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantDictionaryTerms
Description	Clears the dictionary terms.
Compliance	`mandatory`		This method must be implemented.
Method	getDictionaryQueryRecord
Description	Gets the dictionary query record corresponding to the given `Dictionary` record `Type`. Multiple retrievale produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`dictionaryRecordType`	a dictionary record type
Return	`osid.dictionary.records.DictionaryQueryRecord`		the dictionary query record
Errors	NULL_ARGUMENT		`dictionaryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(dictionaryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.