OSID - osid.ordering.ItemQuery Service Interface Definition

Interface	osid.ordering.ItemQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.ordering.OrderQuery`
	`osid.ordering.PriceQuery`
	`osid.ordering.ProductQuery`
Description	This is the query for searching for items. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchOrderId
Description	Sets the order `Id` for this query to match orders assigned to items.
Parameters	`osid.id.Id`	`orderId`	an order `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`orderId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOrderIdTerms
Description	Clears the order `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderQuery
Description	Tests if an order query is available.
Return	`boolean`		`true` if an order query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOrderQuery
Description	Gets the query for an item.
Return	`osid.ordering.OrderQuery`		the order query
Errors	UNIMPLEMENTED		`supportsOrderQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOrderQuery()` is `true`.
Method	clearOrderTerms
Description	Clears the order terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDerived
Description	Matches items that are derived.
Parameters	`boolean`	`match`	`true` to match derived items, `false` to match selected items
Compliance	`mandatory`		This method must be implemented.
Method	clearDerivedTerms
Description	Clears the derived terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProductId
Description	Sets the product `Id` for this query.
Parameters	`osid.id.Id`	`productId`	a product `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`productId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProductIdTerms
Description	Clears the product `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductQuery
Description	Tests if a product query is available.
Return	`boolean`		`true` if a product query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProductQuery
Description	Gets the query for a product.
Return	`osid.ordering.ProductQuery`		the product query
Errors	UNIMPLEMENTED		`supportsProductQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProductQuery()` is `true`.
Method	clearProductTerms
Description	Clears the product terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchQuantity
Description	Matches quantities between the given range inclusive.
Parameters	`cardinal`	`low`	low range
	`cardinal`	`high`	high range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Compliance	`mandatory`		This method must be implemented.
Method	clearQuantityTerms
Description	Clears the quantity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCost
Description	Matches costs between the given range inclusive.
Parameters	`osid.financials.Currency`	`low`	low range
	`osid.financials.Currency`	`high`	high range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCostTerms
Description	Clears the cost terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumCost
Description	Matches minimum costs between the given range inclusive.
Parameters	`osid.financials.Currency`	`cost`	cost
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`cost` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumCostTerms
Description	Clears the minimum cost terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStoreId
Description	Sets the item `Id` for this query to match orders assigned to stores.
Parameters	`osid.id.Id`	`storeId`	a store `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`storeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStoreIdTerms
Description	Clears the store `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStoreQuery
Description	Tests if a `StoreQuery` is available.
Return	`boolean`		`true` if a store query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStoreQuery
Description	Gets the query for a store query. Multiple retrievals produce a nested `OR` term.
Return	`osid.ordering.StoreQuery`		the store query
Errors	UNIMPLEMENTED		`supportsStoreQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStoreQuery()` is `true`.
Method	clearStoreTerms
Description	Clears the store 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 boolean `OR` term.
Parameters	`osid.type.Type`	`itemRecordType`	an item record type
Return	`osid.ordering.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.