OSID - osid.ordering.rules.PriceEnablerQuery Service Interface Definition

Interface	osid.ordering.rules.PriceEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.ordering.rules.PriceEnablerQuerySession`
	`osid.ordering.rules.PriceEnablerSearchSession`
	`osid.ordering.rules.PriceEnablerSmartStoreSession`
Description	This is the query for searching price enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledPriceId
Description	Matches enablers mapped to the price.
Parameters	`osid.id.Id`	`priceId`	the 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	clearRuledPriceIdTerms
Description	Clears the price `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledPriceQuery
Description	Tests if a `PriceQuery` is available.
Return	`boolean`		`true` if a price query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledPriceQuery
Description	Gets the query for a price. Multiple retrievals produce a nested `OR` term.
Return	`osid.ordering.PriceQuery`		the price query
Errors	UNIMPLEMENTED		`supportsRuledPriceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledPriceQuery()` is `true`.
Method	matchAnyRuledPrice
Description	Matches enablers mapped to any price.
Parameters	`boolean`	`match`	`true` for enablers mapped to any price, `false` to match enablers mapped to no price
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledPriceTerms
Description	Clears the price query 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	matchStoreId
Description	Matches enablers mapped to the store.
Parameters	`osid.id.Id`	`storeId`	the 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` query 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. 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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablerQueryRecord
Description	Gets the price enabler query record corresponding to the given `PriceEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`priceEnablerRecordType`	a price enabler record type
Return	`osid.ordering.rules.records.PriceEnablerQueryRecord`		the price enabler query record
Errors	NULL_ARGUMENT		`priceEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(priceEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.