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

Interface	osid.billing.payment.PayerQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidTemporalQuery`
Used By	`osid.billing.payment.PayerQuerySession`
	`osid.billing.payment.PayerSearchSession`
	`osid.billing.payment.PayerSmartBusinessSession`
	`osid.billing.payment.PaymentQuery`
Description	This is the query for searching payers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchResourceId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` if 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 the 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. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		a resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true`.
Method	clearResourceTerms
Description	Clears the resource 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	matchAnyCustomer
Description	Matches payers with any related customer.
Parameters	`boolean`	`match`	`true` to match payers with any related customer, `false` to match payers with no customer
Compliance	`mandatory`		This method must be implemented.
Method	clearCustomerTerms
Description	Clears the customer terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchUsesActivity
Description	Matches payers using their activity account.
Parameters	`boolean`	`match`	`true` to match payers using an activity, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearUsesActivityTerms
Description	Clears the activity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchUsesCash
Description	Matches payers using cash.
Parameters	`boolean`	`match`	`true` to match payers using cash, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearUsesCashTerms
Description	Clears the cash terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreditCardNumber
Description	Matches credit card numbers.
Parameters	`string`	`number`	a credit card number
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`number` not of `stringMatchType`
Errors	NULL_ARGUMENT		`number` or `stringMatchType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCreditCardNumber
Description	Matches payers with any credit card.
Parameters	`boolean`	`match`	`true` to match payers with any credit card, `false` to match payers with no credit card
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditCardNumberTerms
Description	Clears the credit card number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreditCardExpiration
Description	Matches credit card expirations 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	matchAnyCreditCardExpiration
Description	Matches payers with any credit card expiration date.
Parameters	`boolean`	`match`	`true` to match payers with any credit card expiration, `false` to match payers with no credit card expiration
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditCardExpirationTerms
Description	Clears the credit card expiration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreditCardCode
Description	Matches credit card security codes.
Parameters	`string`	`code`	a credit card code
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`code` not of `stringMatchType`
Errors	NULL_ARGUMENT		`code` or `stringMatchType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCreditCardCode
Description	Matches payers with any credit card security code.
Parameters	`boolean`	`match`	`true` to match payers with any credit card security code, `false` to match payers with no credit card security code
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditCardCodeTerms
Description	Clears the credit card code terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBankRoutingNumber
Description	Matches bank routing numbers.
Parameters	`string`	`number`	a bank routing number
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`number` not of `stringMatchType`
Errors	NULL_ARGUMENT		`number` or `stringMatchType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyBankRoutingNumber
Description	Matches payers with any bank routing number.
Parameters	`boolean`	`match`	`true` to match payers with any bank routing number, `false` to match payers with no bank routing number
Compliance	`mandatory`		This method must be implemented.
Method	clearBankRoutingNumberTerms
Description	Clears the bank routing number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBankAccountNumber
Description	Matches bank account numbers.
Parameters	`string`	`number`	a bank account number
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`number` not of `stringMatchType`
Errors	NULL_ARGUMENT		`number` or `stringMatchType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyBankAccountNumber
Description	Matches payers with any bank account number.
Parameters	`boolean`	`match`	`true` to match payers with any bank account number, `false` to match payers with no bank account number
Compliance	`mandatory`		This method must be implemented.
Method	clearBankAccountNumberTerms
Description	Clears the bank account number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match payers 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	getPayerQueryRecord
Description	Gets the payer query record corresponding to the given `Payer` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`payerRecordType`	a payer record type
Return	`osid.billing.payment.records.PayerQueryRecord`		the payer query record
Errors	NULL_ARGUMENT		`payerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(payerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.