OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchyQuery
Implementsosid.OsidCatalogQuery
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.

MethodmatchNodeId
Description

Matches an Id of a node in this hierarchy. Multiple nodes can be added to this query which behave as a boolean AND.

Parametersosid.id.Idid Id to match
booleanmatch true if a positive match, false for negative match
ErrorsNULL_ARGUMENT id is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyNodeId
Description

Matches hierarchies with any node.

Parametersbooleanmatch true to match hierarchies with any nodes, false to match hierarchies with no nodes
CompliancemandatoryThis method must be implemented.
MethodclearNodeIdTerms
Description

Clears the node Id terms.

CompliancemandatoryThis method must be implemented.
MethodgetHierarchyQueryRecord
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.

Parametersosid.type.TypehierarchyRecordTypea hierarchy record type
Returnosid.hierarchy.records.HierarchyQueryRecordthe hierarchy query record
ErrorsNULL_ARGUMENT hierarchyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(hierarchyRecordType) is false
CompliancemandatoryThis method must be implemented.