Interface WarehouseQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable
public interface WarehouseQuery extends OsidCatalogQuery

This is the query for searching warehouses. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchItemId

      void matchItemId(Id itemId, boolean match)
      Sets the item Id for this query.
      Parameters:
      itemId - an item Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - itemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearItemIdTerms

      void clearItemIdTerms()
      Clears the item Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemQuery

      boolean supportsItemQuery()
      Tests if an ItemQuery is available.
      Returns:
      true if an item query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getItemQuery

      ItemQuery getItemQuery()
      Gets the query for an item. Multiple retrievals produce a nested OR term.
      Returns:
      the item query
      Throws:
      UnimplementedException - supportsItemQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsItemQuery()} is {@code true} .

    • matchAnyItem

      void matchAnyItem(boolean match)
      Matches warehouses that have any item.
      Parameters:
      match - true to match warehouses with any item, false to match warehouses with no items
      Compliance:
      mandatory - This method must be implemented.

    • clearItemTerms

      void clearItemTerms()
      Clears the item query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchStockId

      void matchStockId(Id stockId, boolean match)
      Sets the catalog Id for this query.
      Parameters:
      stockId - a stock Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - stockId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStockIdTerms

      void clearStockIdTerms()
      Clears the stock Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockQuery

      boolean supportsStockQuery()
      Tests if a StockQuery is available.
      Returns:
      true if a stock query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStockQuery

      StockQuery getStockQuery()
      Gets the query for a stock. Multiple retrievals produce a nested OR term.
      Returns:
      the stock query
      Throws:
      UnimplementedException - supportsStockQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStockQuery()} is {@code true} .

    • matchAnyStock

      void matchAnyStock(boolean match)
      Matches warehouses that have any stock.
      Parameters:
      match - true to match courses with any stock, false to match courses with no stock
      Compliance:
      mandatory - This method must be implemented.

    • clearStockTerms

      void clearStockTerms()
      Clears the stock query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchModelId

      void matchModelId(Id modelId, boolean match)
      Sets the model Id for this query.
      Parameters:
      modelId - a model Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - modelId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearModelIdTerms

      void clearModelIdTerms()
      Clears the model Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelQuery

      boolean supportsModelQuery()
      Tests if a ModelQuery is available.
      Returns:
      true if a model query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getModelQuery

      ModelQuery getModelQuery()
      Gets the query for an inventory. Multiple retrievals produce a nested OR term.
      Returns:
      the model query
      Throws:
      UnimplementedException - supportsModelQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsModelQuery()} is {@code true} .

    • matchAnyModel

      void matchAnyModel(boolean match)
      Matches any related model.
      Parameters:
      match - true to match warehouses with any model, false to match warehouses with no models
      Compliance:
      mandatory - This method must be implemented.

    • clearModelTerms

      void clearModelTerms()
      Clears the model terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchInventoryId

      void matchInventoryId(Id itemId, boolean match)
      Sets the inventory Id for this query.
      Parameters:
      itemId - an inventory Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - inventoryId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearInventoryIdTerms

      void clearInventoryIdTerms()
      Clears the inventory Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryQuery

      boolean supportsInventoryQuery()
      Tests if an InventoryQuery is available.
      Returns:
      true if an inventory query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getInventoryQuery

      InventoryQuery getInventoryQuery()
      Gets the query for an inventory. Multiple retrievals produce a nested OR term.
      Returns:
      the inventory query
      Throws:
      UnimplementedException - supportsInventoryQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsInventoryQuery()} is {@code true} .

    • matchAnyInventory

      void matchAnyInventory(boolean match)
      Matches warehouses that have any inventory.
      Parameters:
      match - true to match warehouses with any inventory, false to match warehouses with no inventories
      Compliance:
      mandatory - This method must be implemented.

    • clearInventoryTerms

      void clearInventoryTerms()
      Clears the inventory query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAncestorWarehouseId

      void matchAncestorWarehouseId(Id warehouseId, boolean match)
      Sets the warehouse Id for this query to match warehouses that have the specified warehouse as an ancestor.
      Parameters:
      warehouseId - a warehouse Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - warehouseId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorWarehouseIdTerms

      void clearAncestorWarehouseIdTerms()
      Clears the ancestor warehouse Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAncestorWarehouseQuery

      boolean supportsAncestorWarehouseQuery()
      Tests if a WarehouseQuery is available.
      Returns:
      true if a warehouse query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorWarehouseQuery

      WarehouseQuery getAncestorWarehouseQuery()
      Gets the query for a warehouse. Multiple retrievals produce a nested OR term.
      Returns:
      the warehouse query
      Throws:
      UnimplementedException - supportsAncestorWarehouseQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAncestorWarehouseQuery()} is {@code true} .

    • matchAnyAncestorWarehouse

      void matchAnyAncestorWarehouse(boolean match)
      Matches warehouses with any warehouse ancestor.
      Parameters:
      match - true to match warehouses with any ancestor, false to match root warehouses
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorWarehouseTerms

      void clearAncestorWarehouseTerms()
      Clears the ancestor warehouse query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescendantWarehouseId

      void matchDescendantWarehouseId(Id warehouseId, boolean match)
      Sets the warehouse Id for this query to match warehouses that have the specified warehouse as a descendant.
      Parameters:
      warehouseId - a warehouse Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - warehouseId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantWarehouseIdTerms

      void clearDescendantWarehouseIdTerms()
      Clears the descendant warehouse Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDescendantWarehouseQuery

      boolean supportsDescendantWarehouseQuery()
      Tests if a WarehouseQuery is available.
      Returns:
      true if a warehouse query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantWarehouseQuery

      WarehouseQuery getDescendantWarehouseQuery()
      Gets the query for a warehouse. Multiple retrievals produce a nested OR term.
      Returns:
      the warehouse query
      Throws:
      UnimplementedException - supportsDescendantWarehouseQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDescendantWarehouseQuery()} is {@code true} .

    • matchAnyDescendantWarehouse

      void matchAnyDescendantWarehouse(boolean match)
      Matches warehouses with any descendant warehouse.
      Parameters:
      match - true to match warehouses with any descendant, false to match leaf warehouses
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantWarehouseTerms

      void clearDescendantWarehouseTerms()
      Clears the descendant warehouse query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getWarehouseQueryRecord

      WarehouseQueryRecord getWarehouseQueryRecord(Type warehouseRecordType) throws OperationFailedException
      Gets the warehouse query 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 record
      Throws:
      NullArgumentException - warehouseRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(warehouseRecordType) is false
      Compliance:
      mandatory - This method must be implemented.