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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQueryInspector

getRecordTypeTerms

Modifier and Type	Method	Description
TypeTerm[]	getRecordTypeTerms()	Gets the record type query terms.

Methods inherited from interface OsidObjectQueryInspector

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

Modifier and Type	Method	Description
IdTerm[]	getCommentIdTerms()	Gets the comment Id query terms.
CommentQueryInspector[]	getCommentTerms()	Gets the comment query terms.
IdTerm[]	getCreditIdTerms()	Gets the credit Id query terms.
CreditQueryInspector[]	getCreditTerms()	Gets the credit query terms.
StringTerm[]	getDescriptionTerms()	Gets the description query terms.
StringTerm[]	getDisplayNameTerms()	Gets the display name query terms.
TypeTerm[]	getGenusTypeTerms()	Gets the genus type query terms.
IdTerm[]	getJournalEntryIdTerms()	Gets the journal entry Id query terms.
JournalEntryQueryInspector[]	getJournalEntryTerms()	Gets the journal entry query terms.
TypeTerm[]	getParentGenusTypeTerms()	Gets the parent genus type query terms.
IdTerm[]	getRelationshipIdTerms()	Gets the relationship Id query terms.
IdTerm[]	getRelationshipPeerIdTerms()	Gets the relationship peer Id query terms.
RelationshipQueryInspector[]	getRelationshipTerms()	Gets the relationship query terms.
IdTerm[]	getStateIdTerms()	Gets the state Id query terms.
StateQueryInspector[]	getStateTerms()	Gets the state query terms.
StatisticQueryInspector[]	getStatisticTerms()	Gets the statistic query terms.
IdTerm[]	getSubjectIdTerms()	Gets the subject Id query terms.
RelevancyQueryInspector[]	getSubjectRelevancyTerms()	Gets the subject relevancy query terms.
SubjectQueryInspector[]	getSubjectTerms()	Gets the subject query terms.

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Modifier and Type	Method	Description
BooleanTerm[]	getAnyTerms()	Gets the any query terms.
StringTerm[]	getKeywordTerms()	Gets the keyword query terms.

Methods inherited from interface OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Modifier and Type	Method	Description
IdTerm[]	getBrandingIdTerms()	Gets the asset Id query terms.
AssetQueryInspector[]	getBrandingTerms()	Gets the asset query terms.
StringTerm[]	getLicenseTerms()	Gets the license query terms.
IdTerm[]	getProviderIdTerms()	Gets the provider Id query terms.
ResourceQueryInspector[]	getProviderTerms()	Gets the provider query terms.

Method Details

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.