OSID - osid.ordering.PriceScheduleQuery Service Interface Definition

Interface	osid.ordering.PriceScheduleQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidAggregateableQuery`
Used By	`osid.ordering.PriceQuery`
	`osid.ordering.PriceScheduleQuerySession`
	`osid.ordering.PriceScheduleSearchSession`
	`osid.ordering.PriceScheduleSmartStoreSession`
	`osid.ordering.ProductQuery`
	`osid.ordering.StoreQuery`
Description	This is the query for searching for price schedules. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchPriceId
Description	Sets the price `Id` for this query.
Parameters	`osid.id.Id`	`priceId`	a price `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`priceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPriceIdTerms
Description	Clears the price `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceQuery
Description	Tests if a price query is available.
Return	`boolean`		`true` if a price query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPriceQuery
Description	Gets the query for a price.
Return	`osid.ordering.PriceQuery`		the price query
Errors	UNIMPLEMENTED		`supportsPriceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceQuery()` is `true`.
Method	matchAnyPrice
Description	Matches price schedules with any price.
Parameters	`boolean`	`match`	`true` to match price sschedules with any price, `false` to match price schedules with no prices
Compliance	`mandatory`		This method must be implemented.
Method	clearPriceTerms
Description	Clears the price 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	matchAnyProduct
Description	Matches price schedules used with any product.
Parameters	`boolean`	`match`	`true` to match price schedules with any product, `false` to match price schedules with no products
Compliance	`mandatory`		This method must be implemented.
Method	clearProductTerms
Description	Clears the product terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStoreId
Description	Sets the price `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	getPriceScheduleQueryRecord
Description	Gets the price schedule query record corresponding to the given `PriceSchedule` record `Type`. Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`priceScheduleRecordType`	a price schedule record type
Return	`osid.ordering.records.PriceScheduleQueryRecord`		the price schedule query record
Errors	NULL_ARGUMENT		`priceScheduleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(priceScheduleRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.