OSID - osid.billing.payment.PaymentQuery Service Interface Definition

Interface	osid.billing.payment.PaymentQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching payments. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchPayerId
Description	Sets the payer `Id` for this query.
Parameters	`osid.id.Id`	`payerId`	a payer `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`payerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPayerIdTerms
Description	Clears the payer `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerQuery
Description	Tests if a `PayerQuery` is available.
Return	`boolean`		`true` if a payer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPayerQuery
Description	Gets the query for a payer. Multiple retrievals produce a nested `OR` term.
Return	`osid.billing.payment.PayerQuery`		the payer query
Errors	UNIMPLEMENTED		`supportsPayerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerQuery()` is `true.`
Method	clearPayerTerms
Description	Clears the payer terms.
Compliance	`mandatory`		This method must be implemented.
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 `CustomereQuery` 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`		a 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	matchPeriodId
Description	Sets the biliing period `Id` for this query.
Parameters	`osid.id.Id`	`periodId`	a 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 billing 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 billing 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	matchAnyPeriod
Description	Matches payments with any billing period.
Parameters	`boolean`	`match`	`true` to match payments with any period, `false` to match peyments with no period
Compliance	`mandatory`		This method must be implemented.
Method	clearPeriodTerms
Description	Clears the billing period terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPaymentDate
Description	Matches payment dates between the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPaymentDateTerms
Description	Clears the payment date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProcessDate
Description	Matches process dates between the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyProcessDate
Description	Matches payments with any process date.
Parameters	`boolean`	`match`	`true` to match payments with any process date, `false` to match peyments with no process date
Compliance	`mandatory`		This method must be implemented.
Method	clearProcessDateTerms
Description	Clears the process date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAmount
Description	Matches amounts between the given range inclusive.
Parameters	`osid.financials.Currency`	`from`	start of range
	`osid.financials.Currency`	`to`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAmount
Description	Matches payments with any amount.
Parameters	`boolean`	`match`	`true` to match payments with any amount, `false` to match peyments with no amount
Compliance	`mandatory`		This method must be implemented.
Method	clearAmountTerms
Description	Clears the amount.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match payments 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	getPaymentQueryRecord
Description	Gets the payment query record corresponding to the given `Payment` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`paymentRecordType`	a payment record type
Return	`osid.billing.payment.records.PaymentQueryRecord`		the payment query record
Errors	NULL_ARGUMENT		`paymentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(paymentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.