org.osid

Interface OsidCompendiumQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector

All Known Subinterfaces:

StatisticQueryInspector, SummaryQueryInspector

public interface OsidCompendiumQueryInspector
extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to an OsidQuery for reuse or modification in the search sessions.

Method Summary

Methods

Modifier and Type	Method and Description
DateTimeRangeTerm[]	getEndDateTerms() Gets the end date query terms.
BooleanTerm[]	getExtrapolatedTerms() Gets the extrapolated query terms.
BooleanTerm[]	getInterpolatedTerms() Gets the interpolated query terms.
DateTimeRangeTerm[]	getStartDateTerms() Gets the start date 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

Method Detail

getStartDateTerms

DateTimeRangeTerm[] getStartDateTerms()

Gets the start date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEndDateTerms

DateTimeRangeTerm[] getEndDateTerms()

Gets the end date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInterpolatedTerms

BooleanTerm[] getInterpolatedTerms()

Gets the interpolated query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getExtrapolatedTerms

BooleanTerm[] getExtrapolatedTerms()

Gets the extrapolated query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.