OSID - osid.ordering.PriceQuery Service Interface Definition

Interface	osid.ordering.PriceQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidSubjugateableQuery`
Description	This is the query for searching for prices. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchPriceScheduleId
Description	Sets the price schedule `Id` for this query.
Parameters	`osid.id.Id`	`priceScheduleId`	a price schedule `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`priceScheduleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPriceScheduleIdTerms
Description	Clears the price schedule `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleQuery
Description	Tests if a price schedule query is available.
Return	`boolean`		`true` if a price schedule query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleQuery
Description	Gets the query for a price schedule.
Return	`osid.ordering.PriceScheduleQuery`		the price schedule query
Errors	UNIMPLEMENTED		`supportsPriceScheduleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceScheduleQuery()` is `true.`
Method	clearPriceScheduleTerms
Description	Clears the price schedule terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumQuantity
Description	Matches the minimum quantity between the given range inclusive.
Parameters	`cardinal`	`low`	start of range
	`cardinal`	`high`	end of 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	clearMinimumQuantityTerms
Description	Clears the minimum quantity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMaximumQuantity
Description	Matches the maximum quantity between the given range inclusive.
Parameters	`cardinal`	`low`	start of range
	`cardinal`	`high`	end of 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	clearMaximumQuantityTerms
Description	Clears the maximum quantity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDemographicId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resource` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDemographicIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDemographicQuery
Description	Tests if a resource query is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicQuery
Description	Gets the query for a resource.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsDemographicQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicQuery()` is `true.`
Method	matchAnyDemographic
Description	Matches prices with any demographic.
Parameters	`boolean`	`match`	`true` to match prices with any demographic, `false` to match prices with no orders
Compliance	`mandatory`		This method must be implemented.
Method	clearDemographicTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAmount
Description	Matches the amount between the given range inclusive.
Parameters	`osid.financials.Currency`	`low`	start of range
	`osid.financials.Currency`	`high`	end of 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	matchAnyAmount
Description	Matches items that have any amount set.
Parameters	`boolean`	`match`	`true` to match items with any amount, `false` to match items with no amount
Compliance	`mandatory`		This method must be implemented.
Method	clearAmountTerms
Description	Clears the amount terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumAmount
Description	Matches the a minimum price amount.
Parameters	`osid.financials.Currency`	`amount`	an amount
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumAmountTerms
Description	Clears the minimum amount terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRecurringInterval
Description	Matches the recurring interval between the given duration range inclusive.
Parameters	`osid.calendaring.Duration`	`low`	start of range
	`osid.calendaring.Duration`	`high`	end of 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	matchAnyRecurringInterval
Description	Matches prices with any recurring interval.
Parameters	`boolean`	`match`	`true` to match prices with any recurring interval, `false` to match one-time prices
Compliance	`mandatory`		This method must be implemented.
Method	clearRecurringIntervalTerms
Description	Clears the recurring interval terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchItemId
Description	Sets the item `Id` for this query.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`priceScheduleId` 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 item query 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.
Return	`osid.ordering.ItemQuery`		the item query
Errors	UNIMPLEMENTED		`supportsItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemQuery()` is `true.`
Method	matchAnyItem
Description	Matches prices used with any item.
Parameters	`boolean`	`match`	`true` to match prices with any order, `false` to match prices with no orders
Compliance	`mandatory`		This method must be implemented.
Method	clearItemTerms
Description	Clears the item 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	getPriceQueryRecord
Description	Gets the price query record corresponding to the given `Price` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`priceRecordType`	an price record type
Return	`osid.ordering.records.PriceQueryRecord`		the price query record
Errors	NULL_ARGUMENT		`priceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(priceRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.