org.osid.hierarchy

Interface HierarchyQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface HierarchyQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining hierarchy queries.

Method Summary

Methods

Modifier and Type	Method and Description
HierarchyQueryInspectorRecord	getHierarchyQueryInspectorRecord(Type hierarchyRecordType) Gets the hierarchy query inspector record corresponding to the given Hierarchy record Type.
IdTerm[]	getNodeIdTerms() Gets the node Id query terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getNodeIdTerms

IdTerm[] getNodeIdTerms()

Gets the node Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getHierarchyQueryInspectorRecord

HierarchyQueryInspectorRecord getHierarchyQueryInspectorRecord(Type hierarchyRecordType)
                                                               throws OperationFailedException

Gets the hierarchy query inspector record corresponding to the given Hierarchy record Type.

Parameters:

hierarchyRecordType - a hierarchy record type

Returns:

the hierarchy query inspector record

Throws:

NullArgumentException - hierarchyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(hierarchyRecordType) is false

Compliance:

mandatory - This method must be implemented.