OSID - osid.billing.ItemQuery Service Interface Definition

Interface	osid.billing.ItemQuery
Implements	`osid.OsidObjectQuery`
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	matchCategoryId
Description	Sets the category `Id` for this query.
Parameters	`osid.id.Id`	`categoryId`	a category `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`categoryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCategoryIdTerms
Description	Clears the category `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCategoryQuery
Description	Tests if a `CategoryQuery` is available.
Return	`boolean`		`true` if a category query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCategoryQuery
Description	Gets the query for a category. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.CategoryQuery`		a category query
Errors	UNIMPLEMENTED		`supportsCategoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportscategoryQuery()` is `true.`
Method	clearCategoryTerms
Description	Clears the category terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAccountId
Description	Sets the account `Id` for this query to match items that have a related financial account.
Parameters	`osid.id.Id`	`accountId`	an account `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`accountId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAccountIdTerms
Description	Clears the account `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountQuery
Description	Tests if an `AccountQuery` is available.
Return	`boolean`		`true` if an account query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAccountQuery
Description	Gets the query for an account. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.AccountQuery`		the account query
Errors	UNIMPLEMENTED		`supportsAccountQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAccountQuery()` is `true.`
Method	matchAnyAccount
Description	Matches items that have any account.
Parameters	`boolean`	`match`	`true` to match items with any account, `false` to match items with no account
Compliance	`mandatory`		This method must be implemented.
Method	clearAccountTerms
Description	Clears the account terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProductId
Description	Sets the product `Id` for this query to match items that have a related product.
Parameters	`osid.id.Id`	`productId`	a product `Id`
Parameters	`boolean`	`match`	`true` if 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 account `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductQuery
Description	Tests if a `ProductQuery` 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. Multiple retrievals produce a nested `OR` term.
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 items that have any product.
Parameters	`boolean`	`match`	`true` to match items with any product, `false` to match items with no product
Compliance	`mandatory`		This method must be implemented.
Method	clearProductTerms
Description	Clears the product 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	matchDebit
Description	Matches items that have debit amounts.
Parameters	`boolean`	`match`	`true` to match items with a debit amount, `false` to match items with a credit amount
Compliance	`mandatory`		This method must be implemented.
Method	clearDebitTerms
Description	Clears the debit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRecurringInterval
Description	Matches the recurring interval between the given 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 items that have any recurring interval.
Parameters	`boolean`	`match`	`true` to match items with any recurring interval, `false` to match items with a one-time charge
Compliance	`mandatory`		This method must be implemented.
Method	clearRecurringIntervalTerms
Description	Clears the amount terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEntryId
Description	Sets the entry `Id` for this query to match items that have a related entry.
Parameters	`osid.id.Id`	`entryId`	an entry `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`entryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryIdTerms
Description	Clears the entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryQuery
Description	Tests if an `EntryQuery` is available.
Return	`boolean`		`true` if an entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryQuery
Description	Gets the query for an entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.EntryQuery`		the entry query
Errors	UNIMPLEMENTED		`supportsEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryQuery()` is `true.`
Method	matchAnyEntry
Description	Matches items that have any entry.
Parameters	`boolean`	`match`	`true` to match items with any entry. `false` to match items with no entry
Compliance	`mandatory`		This method must be implemented.
Method	clearEntryTerms
Description	Clears the entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match customers assigned to businesses.
Parameters	`osid.id.Id`	`businessId`	the business `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`businessId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBusinessIdTerms
Description	Clears the business `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessQuery
Description	Tests if a `BusinessQuery` is available.
Return	`boolean`		`true` if a business query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessQuery
Description	Gets the query for a business. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.BusinessQuery`		the business query
Errors	UNIMPLEMENTED		`supportsBusinessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBusinessQuery()` is `true.`
Method	clearBusinessTerms
Description	Clears the business terms.
Compliance	`mandatory`		This method must be implemented.
Method	getItemQueryRecord
Description	Gets the item query record corresponding to the given `Customer` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`itemRecordType`	an item record type
Return	`osid.billing.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.