Interface ItemQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
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.

  • Method Details

    • getCategoryIdTerms

      IdTerm[] getCategoryIdTerms()
      Gets the category Id query terms.
      Returns:
      the category Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCategoryTerms

      CategoryQueryInspector[] getCategoryTerms()
      Gets the category query terms.
      Returns:
      the category query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAccountIdTerms

      IdTerm[] getAccountIdTerms()
      Gets the account Id query terms.
      Returns:
      the account Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAccountTerms

      AccountQueryInspector[] getAccountTerms()
      Gets the account query terms.
      Returns:
      the account query terms
      Compliance:
      mandatory - This method must be implemented.

    • getProductIdTerms

      IdTerm[] getProductIdTerms()
      Gets the product Id query terms.
      Returns:
      the product Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getProductTerms

      ProductQueryInspector[] getProductTerms()
      Gets the product query terms.
      Returns:
      the product query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAmountTerms

      CurrencyRangeTerm[] getAmountTerms()
      Gets the amount terms.
      Returns:
      the amount terms
      Compliance:
      mandatory - This method must be implemented.

    • getDebitTerms

      BooleanTerm[] getDebitTerms()
      Gets the debit terms.
      Returns:
      the debit terms
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringIntervalTerms

      DurationRangeTerm[] getRecurringIntervalTerms()
      Gets the recurring interval terms.
      Returns:
      the recurring interval terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntryIdTerms

      IdTerm[] getEntryIdTerms()
      Gets the entry Id query terms.
      Returns:
      the entry Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getEntryTerms

      EntryQueryInspector[] getEntryTerms()
      Gets the entry query terms.
      Returns:
      the entry query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessIdTerms

      IdTerm[] getBusinessIdTerms()
      Gets the business Id query terms.
      Returns:
      the business Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessTerms

      BusinessQueryInspector[] getBusinessTerms()
      Gets the business query terms.
      Returns:
      the business query terms
      Compliance:
      mandatory - This method must be implemented.

    • getItemQueryInspectorRecord

      ItemQueryInspectorRecord getItemQueryInspectorRecord(Type itemRecordType) throws OperationFailedException
      Gets the item query inspector record corresponding to the given Item record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      itemRecordType - an item record type
      Returns:
      the item query inspector record
      Throws:
      NullArgumentException - itemRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(itemRecordType) is false
      Compliance:
      mandatory - This method must be implemented.