OSID - osid.acknowledgement.CreditQuery Service Interface Definition

Interface	osid.acknowledgement.CreditQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.OsidObjectQuery`
	`osid.acknowledgement.BillingQuery`
	`osid.acknowledgement.CreditQuerySession`
	`osid.acknowledgement.CreditSearchSession`
	`osid.acknowledgement.CreditSmartBillingSession`
Description	This is the query for searching credits. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchReferenceId
Description	Sets reference `Id`.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`referenceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearReferenceIdTerms
Description	Clears all reference `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResourceId
Description	Sets a resource `Id`.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceIdTerms
Description	Clears all resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQuery
Description	Gets the query for a resource query. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true`.
Method	clearResourceTerms
Description	Clears all resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBillingId
Description	Sets the billing `Id` for this query to match credits assigned to billings.
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	clearBillingIdTerms
Description	Clears all billing `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBillingQuery
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	getBillingQuery
Description	Gets the query for a billing query. Multiple retrievals produce a nested `OR` term.
Return	`osid.acknowledgement.BillingQuery`		the billing query
Errors	UNIMPLEMENTED		`supportsBillingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBillingQuery()` is `true`.
Method	clearBillingTerms
Description	Clears all billing terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCreditQueryRecord
Description	Gets the credit query record corresponding to the given `Credit` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`creditRecordType`	a credit record type
Return	`osid.acknowledgement.records.CreditQueryRecord`		the credit query record
Errors	NULL_ARGUMENT		`creditRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(creditRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.