org.osid.cataloging.rules

Interface CatalogEnablerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface CatalogEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining catalog enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
CatalogEnablerQueryInspectorRecord	getCatalogEnablerQueryInspectorRecord(Type catalogEnablerRecordType) Gets the catalog enabler query inspector record corresponding to the given CatalogEnabler record Type.
IdTerm[]	getCatalogIdTerms() Gets the catalog Id query terms.
CatalogQueryInspector[]	getCatalogTerms() Gets the catalog query terms.
IdTerm[]	getRuledCatalogIdTerms() Gets the catalog Id query terms.
CatalogQueryInspector[]	getRuledCatalogTerms() Gets the catalog query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledCatalogIdTerms

IdTerm[] getRuledCatalogIdTerms()

Gets the catalog Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledCatalogTerms

CatalogQueryInspector[] getRuledCatalogTerms()

Gets the catalog query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCatalogIdTerms

IdTerm[] getCatalogIdTerms()

Gets the catalog Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCatalogTerms

CatalogQueryInspector[] getCatalogTerms()

Gets the catalog query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerQueryInspectorRecord

CatalogEnablerQueryInspectorRecord getCatalogEnablerQueryInspectorRecord(Type catalogEnablerRecordType)
                                                                         throws OperationFailedException

Gets the catalog enabler query inspector record corresponding to the given CatalogEnabler record Type.

Parameters:

catalogEnablerRecordType - a catalog enabler record type

Returns:

the catalog enabler query inspector record

Throws:

NullArgumentException - catalogEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.