OSID - osid.inventory.WarehouseQuery Service Interface Definition

Interface	osid.inventory.WarehouseQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.inventory.InventoryQuery`
	`osid.inventory.ItemQuery`
	`osid.inventory.ModelQuery`
	`osid.inventory.StockQuery`
	`osid.inventory.WarehouseQuery`
	`osid.inventory.WarehouseQuerySession`
	`osid.inventory.WarehouseSearchSession`
	`osid.inventory.shipment.EntryQuery`
	`osid.inventory.shipment.ShipmentQuery`
Description	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	matchItemId
Description	Sets the item `Id` for this query.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`itemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearItemIdTerms
Description	Clears the item `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemQuery
Description	Tests if an `ItemQuery` is available.
Return	`boolean`		`true` if an item query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getItemQuery
Description	Gets the query for an item. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.ItemQuery`		the item query
Errors	UNIMPLEMENTED		`supportsItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemQuery()` is `true`.
Method	matchAnyItem
Description	Matches warehouses that have any item.
Parameters	`boolean`	`match`	`true` to match warehouses with any item, `false` to match warehouses with no items
Compliance	`mandatory`		This method must be implemented.
Method	clearItemTerms
Description	Clears the item query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStockId
Description	Sets the catalog `Id` for this query.
Parameters	`osid.id.Id`	`stockId`	a stock `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`stockId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStockIdTerms
Description	Clears the stock `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockQuery
Description	Tests if a `StockQuery` is available.
Return	`boolean`		`true` if a stock query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStockQuery
Description	Gets the query for a stock. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.StockQuery`		the stock query
Errors	UNIMPLEMENTED		`supportsStockQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockQuery()` is `true`.
Method	matchAnyStock
Description	Matches warehouses that have any stock.
Parameters	`boolean`	`match`	`true` to match courses with any stock, `false` to match courses with no stock
Compliance	`mandatory`		This method must be implemented.
Method	clearStockTerms
Description	Clears the stock query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchModelId
Description	Sets the model `Id` for this query.
Parameters	`osid.id.Id`	`modelId`	a model `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`modelId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearModelIdTerms
Description	Clears the model `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelQuery
Description	Tests if a `ModelQuery` is available.
Return	`boolean`		`true` if a model query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getModelQuery
Description	Gets the query for an inventory. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.ModelQuery`		the model query
Errors	UNIMPLEMENTED		`supportsModelQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelQuery()` is `true`.
Method	matchAnyModel
Description	Matches any related model.
Parameters	`boolean`	`match`	`true` to match warehouses with any model, `false` to match warehouses with no models
Compliance	`mandatory`		This method must be implemented.
Method	clearModelTerms
Description	Clears the model terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInventoryId
Description	Sets the inventory `Id` for this query.
Parameters	`osid.id.Id`	`itemId`	an inventory `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`inventoryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInventoryIdTerms
Description	Clears the inventory `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryQuery
Description	Tests if an `InventoryQuery` is available.
Return	`boolean`		`true` if an inventory query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInventoryQuery
Description	Gets the query for an inventory. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.InventoryQuery`		the inventory query
Errors	UNIMPLEMENTED		`supportsInventoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryQuery()` is `true`.
Method	matchAnyInventory
Description	Matches warehouses that have any inventory.
Parameters	`boolean`	`match`	`true` to match warehouses with any inventory, `false` to match warehouses with no inventories
Compliance	`mandatory`		This method must be implemented.
Method	clearInventoryTerms
Description	Clears the inventory query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorWarehouseId
Description	Sets the warehouse `Id` for this query to match warehouses that have the specified warehouse as an ancestor.
Parameters	`osid.id.Id`	`warehouseId`	a warehouse `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`warehouseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorWarehouseIdTerms
Description	Clears the ancestor warehouse `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorWarehouseQuery
Description	Tests if a `WarehouseQuery` is available.
Return	`boolean`		`true` if a warehouse query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorWarehouseQuery
Description	Gets the query for a warehouse. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.WarehouseQuery`		the warehouse query
Errors	UNIMPLEMENTED		`supportsAncestorWarehouseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorWarehouseQuery()` is `true`.
Method	matchAnyAncestorWarehouse
Description	Matches warehouses with any warehouse ancestor.
Parameters	`boolean`	`match`	`true` to match warehouses with any ancestor, `false` to match root warehouses
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorWarehouseTerms
Description	Clears the ancestor warehouse query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantWarehouseId
Description	Sets the warehouse `Id` for this query to match warehouses that have the specified warehouse as a descendant.
Parameters	`osid.id.Id`	`warehouseId`	a warehouse `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`warehouseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantWarehouseIdTerms
Description	Clears the descendant warehouse `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantWarehouseQuery
Description	Tests if a `WarehouseQuery` is available.
Return	`boolean`		`true` if a warehouse query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantWarehouseQuery
Description	Gets the query for a warehouse. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.WarehouseQuery`		the warehouse query
Errors	UNIMPLEMENTED		`supportsDescendantWarehouseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantWarehouseQuery()` is `true`.
Method	matchAnyDescendantWarehouse
Description	Matches warehouses with any descendant warehouse.
Parameters	`boolean`	`match`	`true` to match warehouses with any descendant, `false` to match leaf warehouses
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantWarehouseTerms
Description	Clears the descendant warehouse query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseQueryRecord
Description	Gets the warehouse query record corresponding to the given `Warehouse` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`warehouseRecordType`	a warehouse record type
Return	`osid.inventory.records.WarehouseQueryRecord`		the warehouse query record
Errors	NULL_ARGUMENT		`warehouseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(warehouseRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.