OSID Logo
OSID Specifications
cataloging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.cataloging.CatalogQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining catalog queries.

MethodgetIdTerms
Description

Gets the Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorCatalogIdTerms
Description

Gets the ancestor catalog Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorCatalogTerms
Description

Gets the ancestor catalog query terms.

Returnosid.cataloging.CatalogQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantCatalogIdTerms
Description

Gets the descendant catalog Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantCatalogTerms
Description

Gets the descendant catalog query terms.

Returnosid.cataloging.CatalogQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetCatalogQueryInspectorRecord
Description

Gets the catalog query inspector record corresponding to the given Catalog record Type.

Parametersosid.type.TypecatalogRecordTypea catalog record type
Returnosid.cataloging.records.CatalogQueryInspectorRecordthe catalog query inspector record
ErrorsNULL_ARGUMENT catalogRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(catalogRecordType) is false
CompliancemandatoryThis method must be implemented.