OSID - osid.hierarchy.HierarchyQuery Service Interface Definition

Interface	osid.hierarchy.HierarchyQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.authorization.FunctionQuery`
	`osid.authorization.QualifierQuery`
	`osid.hierarchy.HierarchyQuerySession`
	`osid.hierarchy.HierarchySearchSession`
Description	This is the query for searching hierarchies. Results are returned if all the specified elements match. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`, except for accessing the `HierarchyQuery` record.
Method	matchNodeId
Description	Matches an `Id` of a node in this hierarchy. Multiple nodes can be added to this query which behave as a boolean `AND`.
Parameters	`osid.id.Id`	`id`	`Id` to match
Parameters	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`id` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyNodeId
Description	Matches hierarchies with any node.
Parameters	`boolean`	`match`	`true` to match hierarchies with any nodes, `false` to match hierarchies with no nodes
Compliance	`mandatory`		This method must be implemented.
Method	clearNodeIdTerms
Description	Clears the node `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchyQueryRecord
Description	Gets the hierarchy record query corresponding to the given `Hierarchy` record `Type`. Multiple record retrievals of the same type may return the same underlying object and do not result in adding terms to the query. Multiple record retrievals of different types add `AND` terms to the other elements set in this form.
Parameters	`osid.type.Type`	`hierarchyRecordType`	a hierarchy record type
Return	`osid.hierarchy.records.HierarchyQueryRecord`		the hierarchy query record
Errors	NULL_ARGUMENT		`hierarchyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(hierarchyRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.