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
Modifier and TypeMethodDescriptionGets the end date query terms.Gets the extrapolated query terms.Gets the interpolated query terms.Gets the start date query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Method Details
-
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.
-