OSID - osid.inventory.InventoryQuery Service Interface Definition

Interface	osid.inventory.InventoryQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.inventory.InventoryQuerySession`
	`osid.inventory.InventorySearchSession`
	`osid.inventory.InventorySmartWarehouseSession`
	`osid.inventory.WarehouseQuery`
Description	This is the query for searching inventories. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchStockId
Description	Sets the stock `Id` for this query.
Parameters	`osid.id.Id`	`stockId`	the stock `Id`
Parameters	`boolean`	`match`	`true` for 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` 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 stocjk. 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	clearStockTerms
Description	Clears the stock terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDate
Description	Matches inventories where the given time falls within a denormalized inventory date inclusive.
Parameters	`osid.calendaring.DateTime`	`date`	a date
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDateTerms
Description	Clears the meeting time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDateInclusive
Description	Matches inventories with any denormalized date within the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	a start date
	`osid.calendaring.DateTime`	`end`	an end date
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDateInclusiveTerms
Description	Clears the date inclusive terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchQuantity
Description	Matches inventories with a quantity within the given range inclusive.
Parameters	`decimal`	`start`	start range
	`decimal`	`end`	end range
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	clearQuantityTerms
Description	Clears the quantity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWarehouseId
Description	Sets the warehouse `Id` for this query to match inventories assigned to warehouses.
Parameters	`osid.id.Id`	`warehouseId`	the 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	clearWarehouseIdTerms
Description	Clears the warehouse `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseQuery
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	getWarehouseQuery
Description	Gets the query for a warehouse. Multiple retrievals produce a nested `OR` term.
Return	`osid.inventory.WarehouseQuery`		the warehouse query
Errors	UNIMPLEMENTED		`supportsWarehouseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWarehouseQuery()` is `true`.
Method	clearWarehouseTerms
Description	Clears the warehouse terms.
Compliance	`mandatory`		This method must be implemented.
Method	getInventoryQueryRecord
Description	Gets the inventory query record corresponding to the given `Inventory` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`inventoryRecordType`	an inventory record type
Return	`osid.inventory.records.InventoryQueryRecord`		the inventory query record
Errors	NULL_ARGUMENT		`inventoryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(inventoryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.