| Interface | osid.hierarchy.HierarchyQuery | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQuery | ||
| Description | 
                 This is the query for searching hierarchies. Results are 
                returned if all the specified elements match. Each method 
                match request produces an   | ||
| Method | matchNodeId | ||
| Description | 
                     Matches an   | ||
| Parameters | osid.id.Id | id |  Id  to match  | 
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   | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getHierarchyQueryRecord | ||
| Description | 
                     Gets the hierarchy record query corresponding to the 
                    given   | ||
| 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. | |