Interface InventoryQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector
public interface InventoryQueryInspector 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 OsidQuery interfaces for reuse or modification in the search sessions.

  • Method Details

    • getStockIdTerms

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

    • getStockTerms

      StockQueryInspector[] getStockTerms()
      Gets the stock query terms.
      Returns:
      the stock query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDateTerms

      DateTimeTerm[] getDateTerms()
      Gets the date query terms.
      Returns:
      the date query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDateInclusiveTerms

      DateTimeRangeTerm[] getDateInclusiveTerms()
      Gets the date query terms.
      Returns:
      the date range query terms
      Compliance:
      mandatory - This method must be implemented.

    • getQuantityTerms

      DecimalRangeTerm[] getQuantityTerms()
      Gets the quantity terms.
      Returns:
      the quantity query terms
      Compliance:
      mandatory - This method must be implemented.

    • getWarehouseIdTerms

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

    • getWarehouseTerms

      WarehouseQueryInspector[] getWarehouseTerms()
      Gets the warehouse query terms.
      Returns:
      the warehouse query terms
      Compliance:
      mandatory - This method must be implemented.

    • getInventoryQueryInspectorRecord

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