public interface CategoryQueryInspector extends OsidObjectQueryInspector
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 OsidQuery
interfaces for reuse or
modification in the search sessions.
Modifier and Type | Method and Description |
---|---|
IdTerm[] |
getBusinessIdTerms()
Gets the business
Id query terms. |
BusinessQueryInspector[] |
getBusinessTerms()
Gets the business query terms.
|
CategoryQueryInspectorRecord |
getCategoryQueryInspectorRecord(Type categoryRecordType)
Gets the category query inspector record corresponding to the given
Category record Type. |
IdTerm[] |
getEntryIdTerms()
Gets the entry
Id query terms. |
EntryQueryInspector[] |
getEntryTerms()
Gets the entry query terms.
|
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms
getIdTerms
getRecordTypeTerms
getRecordTypes, hasRecordType
getAnyTerms, getKeywordTerms
IdTerm[] getEntryIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. EntryQueryInspector[] getEntryTerms()
mandatory
- This method must be implemented. IdTerm[] getBusinessIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. BusinessQueryInspector[] getBusinessTerms()
mandatory
- This method must be implemented. CategoryQueryInspectorRecord getCategoryQueryInspectorRecord(Type categoryRecordType) throws OperationFailedException
Category
record Type.
Multiple record
retrievals produce a nested OR
term.categoryRecordType
- a category record typeNullArgumentException
- categoryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(categoryRecordType)
is false
mandatory
- This method must be implemented.