OSID - osid.billing.EntryQuery Service Interface Definition

Interface	osid.billing.EntryQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.billing.BusinessQuery`
	`osid.billing.CategoryQuery`
	`osid.billing.EntryQuerySession`
	`osid.billing.EntrySearchSession`
	`osid.billing.EntrySmartBusinessSession`
	`osid.billing.ItemQuery`
Description	This is the query for searching entries. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchCustomerId
Description	Sets the customer `Id` for this query.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`customerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCustomerIdTerms
Description	Clears the customer `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerQuery
Description	Tests if a `CustomerQuery` is available.
Return	`boolean`		`true` if a customer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerQuery
Description	Gets the query for a customer. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.CustomerQuery`		the customer query
Errors	UNIMPLEMENTED		`supportsCustomerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCustomerQuery()` is `true`.
Method	clearCustomerTerms
Description	Clears the customer 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` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`itemId` 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 `ItemQuery` 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. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.ItemQuery`		the item query
Errors	UNIMPLEMENTED		`supportsItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemQuery()` is `true`.
Method	clearItemTerms
Description	Clears the item terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPeriodId
Description	Sets the period `Id` for this query to match categories that have a related term.
Parameters	`osid.id.Id`	`periodId`	a billing period `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`periodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPeriodIdTerms
Description	Clears the period `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodQuery
Description	Tests if a `PeriodQuery` is available.
Return	`boolean`		`true` if a period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodQuery
Description	Gets the query for a reporting period. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.PeriodQuery`		the period query
Errors	UNIMPLEMENTED		`supportsPeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPeriodQuery()` is `true`.
Method	clearPeriodTerms
Description	Clears the period terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchQuantity
Description	Matches entries with a quantity between the given range inclusive.
Parameters	`cardinal`	`low`	start of range
	`cardinal`	`high`	end of range
	`boolean`	`match`	`true` if 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	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	matchBusinessId
Description	Sets the business `Id` for this query to match entries 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	getEntryQueryRecord
Description	Gets the entry query record corresponding to the given `Entry` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`entryRecordType`	an entry record type
Return	`osid.billing.records.EntryQueryRecord`		the entry query record
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(entryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.