org.osid.cataloging

Interface CatalogQueryInspector

All Superinterfaces:

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

public interface CatalogQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining catalog queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorCatalogIdTerms() Gets the ancestor catalog Id query terms.
CatalogQueryInspector[]	getAncestorCatalogTerms() Gets the ancestor catalog query terms.
CatalogQueryInspectorRecord	getCatalogQueryInspectorRecord(Type catalogRecordType) Gets the catalog query inspector record corresponding to the given Catalog record Type.
IdTerm[]	getDescendantCatalogIdTerms() Gets the descendant catalog Id query terms.
CatalogQueryInspector[]	getDescendantCatalogTerms() Gets the descendant catalog query terms.
IdTerm[]	getIdTerms() Gets the 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.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

getIdTerms

IdTerm[] getIdTerms()

Gets the Id query terms.

Specified by:

getIdTerms in interface OsidIdentifiableQueryInspector

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorCatalogIdTerms

IdTerm[] getAncestorCatalogIdTerms()

Gets the ancestor catalog Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorCatalogTerms

CatalogQueryInspector[] getAncestorCatalogTerms()

Gets the ancestor catalog query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantCatalogIdTerms

IdTerm[] getDescendantCatalogIdTerms()

Gets the descendant catalog Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantCatalogTerms

CatalogQueryInspector[] getDescendantCatalogTerms()

Gets the descendant catalog query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCatalogQueryInspectorRecord

CatalogQueryInspectorRecord getCatalogQueryInspectorRecord(Type catalogRecordType)
                                                           throws OperationFailedException

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

Parameters:

catalogRecordType - a catalog record type

Returns:

the catalog query inspector record

Throws:

NullArgumentException - catalogRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogRecordType) is false

Compliance:

mandatory - This method must be implemented.