OSID - osid.inventory.ItemQuery Service Interface Definition

Interface	osid.inventory.ItemQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.inventory.ItemQuery`
	`osid.inventory.ItemQuerySession`
	`osid.inventory.ItemSearchSession`
	`osid.inventory.ItemSmartWarehouseSession`
	`osid.inventory.WarehouseQuery`
	`osid.inventory.shipment.EntryQuery`
Description	This is the query for searching items. 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	matchAnyStock
Description	Matches items that have any stock.
Parameters	`boolean`	`match`	`true` to match items with any stock, `false` to match items with no stock
Compliance	`mandatory`		This method must be implemented.
Method	clearStockTerms
Description	Clears the stock terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPropertyTag
Description	Matches a property identification number.
Parameters	`string`	`property`	a property number
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`property` or `stringMatchType` is `null`
Errors	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPropertyTag
Description	Matches items that have any property tag.
Parameters	`boolean`	`match`	`true` to match items with any property tag, `false` to match items with no property tag
Compliance	`mandatory`		This method must be implemented.
Method	clearPropertyTagTerms
Description	Clears the property tag terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSerialNumber
Description	Matches a serial number.
Parameters	`string`	`serial`	a serial number
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`serial` or `stringMatchType` is `null`
Errors	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySerialNumber
Description	Matches items that have any serial number.
Parameters	`boolean`	`match`	`true` to match items with any serial number, `false` to match items with no serial number
Compliance	`mandatory`		This method must be implemented.
Method	clearSerialNumberTerms
Description	Clears the serial number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLocationDescription
Description	Matches a location description.
Parameters	`string`	`location`	a location string
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`location` or `stringMatchType` is `null`
Errors	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyLocationDescription
Description	Matches items that have any location description.
Parameters	`boolean`	`match`	`true` to match items with any location string, `false` to match items with no location string
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationDescriptionTerms
Description	Clears the location description terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLocationId
Description	Sets the location `Id` for this query.
Parameters	`osid.id.Id`	`locationId`	the location `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`locationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationIdTerms
Description	Clears the location `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationQuery
Description	Tests if a `LocationQuery` is available.
Return	`boolean`		`true` if a location query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationQuery
Description	Gets the query for a location. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.LocationQuery`		the location query
Errors	UNIMPLEMENTED		`supportsLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationQuery()` is `true`.
Method	matchAnyLocation
Description	Matches items that have any location.
Parameters	`boolean`	`match`	`true` to match items with any location, `false` to match items with no location
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationTerms
Description	Clears the location terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchItemId
Description	Sets the item `Id` for this query to match items part of the given item.
Parameters	`osid.id.Id`	`itemId`	the item `Id`
Parameters	`boolean`	`match`	`true` for 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` 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 items that have any item.
Parameters	`boolean`	`match`	`true` to match items part of any item, `false` to match items psrt of no item
Compliance	`mandatory`		This method must be implemented.
Method	clearItemTerms
Description	Clears the item terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWarehouseId
Description	Sets the warehouse `Id` for this query to match items 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` 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	getItemQueryRecord
Description	Gets the item query record corresponding to the given `Item` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`itemRecordType`	an item record type
Return	`osid.inventory.records.ItemQueryRecord`		the item query record
Errors	NULL_ARGUMENT		`itemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(itemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.