Interface WarehouseQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface WarehouseQueryInspector extends OsidCatalogQueryInspector

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

    • getItemIdTerms

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

    • getItemTerms

      ItemQueryInspector[] getItemTerms()
      Gets the item query terms.
      Returns:
      the item query terms
      Compliance:
      mandatory - This method must be implemented.

    • 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.

    • getModelIdTerms

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

    • getModelTerms

      ModelQueryInspector[] getModelTerms()
      Gets the model query terms.
      Returns:
      the model query terms
      Compliance:
      mandatory - This method must be implemented.

    • getInventoryIdTerms

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

    • getInventoryTerms

      InventoryQueryInspector[] getInventoryTerms()
      Gets the inventory query terms.
      Returns:
      the inventory query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorWarehouseIdTerms

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

    • getAncestorWarehouseTerms

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

    • getDescendantWarehouseIdTerms

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

    • getDescendantWarehouseTerms

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

    • getWarehouseQueryInspectorRecord

      WarehouseQueryInspectorRecord getWarehouseQueryInspectorRecord(Type warehouseRecordType) throws OperationFailedException
      Gets the warehouse query inspector record corresponding to the given Warehouse record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      warehouseRecordType - a warehouse record type
      Returns:
      the warehouse query inspector record
      Throws:
      NullArgumentException - warehouseRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(warehouseRecordType) is false
      Compliance:
      mandatory - This method must be implemented.