OSID - osid.acknowledgement.BillingQuery Service Interface Definition

Interface	osid.acknowledgement.BillingQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.acknowledgement.BillingQuery`
	`osid.acknowledgement.BillingQuerySession`
	`osid.acknowledgement.BillingSearchSession`
	`osid.acknowledgement.CreditQuery`
Description	This is the query for searching for billings. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchCreditId
Description	Sets the credit `Id` for this query to match credits assigned to billings.
Parameters	`osid.id.Id`	`creditId`	a credit `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`creditId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditIdTerms
Description	Clears all credit `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCreditQuery
Description	Tests if a credit query is available.
Return	`boolean`		`true` if a credit query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreditQuery
Description	Gets the query for a billing.
Return	`osid.acknowledgement.CreditQuery`		the credit query
Errors	UNIMPLEMENTED		`supportsCreditQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditQuery()` is `true`.
Method	matchAnyCredit
Description	Matches billings with any credit.
Parameters	`boolean`	`match`	`true` to match billings with any credit, `false` to match billings with no credits
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditTerms
Description	Clears all credit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorBillingId
Description	Sets the billing `Id` for this query to match billings that have the specified billing as an ancestor.
Parameters	`osid.id.Id`	`billingId`	a billing `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`billingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBillingIdTerms
Description	Clears all ancestor billing `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorBillingQuery
Description	Tests if a `BillingQuery` is available.
Return	`boolean`		`true` if a billing query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorBillingQuery
Description	Gets the query for a billing. Multiple retrievals produce a nested `OR` term.
Return	`osid.acknowledgement.BillingQuery`		the billing query
Errors	UNIMPLEMENTED		`supportsAncestorBillingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorBillingQuery()` is `true`.
Method	matchAnyAncestorBilling
Description	Matches billings with any ancestor.
Parameters	`boolean`	`match`	`true` to match billings with any ancestor, `false` to match root billings
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBillingTerms
Description	Clears all ancestor billing terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantBillingId
Description	Sets the billing `Id` for this query to match billings that have the specified billing as a descendant.
Parameters	`osid.id.Id`	`billingId`	a billing `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`billingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBillingIdTerms
Description	Clears all descendant billing `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantBillingQuery
Description	Tests if a `BillingQuery` is available.
Return	`boolean`		`true` if a billing query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantBillingQuery
Description	Gets the query for a billing. Multiple retrievals produce a nested `OR` term.
Return	`osid.acknowledgement.BillingQuery`		the billing query
Errors	UNIMPLEMENTED		`supportsDescendantBillingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantBillingQuery()` is `true`.
Method	matchAnyDescendantBilling
Description	Matches billings with any descendant.
Parameters	`boolean`	`match`	`true` to match billings with any descendant, `false` to match leaf billings
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBillingTerms
Description	Clears all descendant billing terms.
Compliance	`mandatory`		This method must be implemented.
Method	getBillingQueryRecord
Description	Gets the record query corresponding to the given `Billing` record `Type`.Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`billingRecordType`	a billing record type
Return	`osid.acknowledgement.records.BillingQueryRecord`		the billing query record
Errors	NULL_ARGUMENT		`billingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(billingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.