public interface ItemQueryInspector 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[] |
getAccountIdTerms()
Gets the account
Id query terms. |
AccountQueryInspector[] |
getAccountTerms()
Gets the account query terms.
|
CurrencyRangeTerm[] |
getAmountTerms()
Gets the amount terms.
|
IdTerm[] |
getBusinessIdTerms()
Gets the business
Id query terms. |
BusinessQueryInspector[] |
getBusinessTerms()
Gets the business query terms.
|
IdTerm[] |
getCategoryIdTerms()
Gets the category
Id query terms. |
CategoryQueryInspector[] |
getCategoryTerms()
Gets the category query terms.
|
BooleanTerm[] |
getDebitTerms()
Gets the debit terms.
|
IdTerm[] |
getEntryIdTerms()
Gets the entry
Id query terms. |
EntryQueryInspector[] |
getEntryTerms()
Gets the entry query terms.
|
ItemQueryInspectorRecord |
getItemQueryInspectorRecord(Type itemRecordType)
Gets the item query inspector record corresponding to the given
Item record Type. |
IdTerm[] |
getProductIdTerms()
Gets the product
Id query terms. |
ProductQueryInspector[] |
getProductTerms()
Gets the product query terms.
|
DurationRangeTerm[] |
getRecurringIntervalTerms()
Gets the recurring interval 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[] getCategoryIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. CategoryQueryInspector[] getCategoryTerms()
mandatory
- This method must be implemented. IdTerm[] getAccountIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. AccountQueryInspector[] getAccountTerms()
mandatory
- This method must be implemented. IdTerm[] getProductIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. ProductQueryInspector[] getProductTerms()
mandatory
- This method must be implemented. CurrencyRangeTerm[] getAmountTerms()
mandatory
- This method must be implemented. BooleanTerm[] getDebitTerms()
mandatory
- This method must be implemented. DurationRangeTerm[] getRecurringIntervalTerms()
mandatory
- This method must be implemented. 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. ItemQueryInspectorRecord getItemQueryInspectorRecord(Type itemRecordType) throws OperationFailedException
Item
record Type.
Multiple record retrievals
produce a nested OR
term.itemRecordType
- an item record typeNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(itemRecordType)
is false
mandatory
- This method must be implemented.