Interface StockQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
public interface StockQueryInspector extends OsidObjectQueryInspector, OsidFederateableQueryInspector

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

    • getSKUTerms

      StringTerm[] getSKUTerms()
      Gets the SKU query terms.
      Returns:
      the SKU 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.

    • getLocationDescriptionTerms

      StringTerm[] getLocationDescriptionTerms()
      Gets the location description query terms.
      Returns:
      the location description query terms
      Compliance:
      mandatory - This method must be implemented.

    • getLocationIdTerms

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

    • getLocationTerms

      LocationQueryInspector[] getLocationTerms()
      Gets the location query terms.
      Returns:
      the location query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorStockIdTerms

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

    • getAncestorStockTerms

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

    • getDescendantStockIdTerms

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

    • getDescendantStockTerms

      StockQueryInspector[] getDescendantStockTerms()
      Gets the descendant stock query terms.
      Returns:
      the descendant stock 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.

    • getStockQueryInspectorRecord

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