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

Interface	osid.billing.payment.PaymentQueryInspector
Implements	`osid.OsidObjectQueryInspector`
Used By	`osid.billing.payment.PaymentSearchResults`
Used By	`osid.billing.payment.PaymentSmartBusinessSession`
Description	The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to `OsidQuery` interfaces for reuse or modification in the search sessions. Like all `OsidQueryInspectors`, `PaymentQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getPayerIdTerms
Description	Gets the payer `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the payer `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getPayerTerms
Description	Gets the payer query terms.
Return	`osid.billing.payment.PayerQueryInspector[]`		the payer query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerIdTerms
Description	Gets the customer `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the customer `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerTerms
Description	Gets the customer query terms.
Return	`osid.billing.CustomerQueryInspector[]`		the customer query terms
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodIdTerms
Description	Gets the period `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the period `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodTerms
Description	Gets the period query terms.
Return	`osid.billing.PeriodQueryInspector[]`		the period query terms
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentDateTerms
Description	Gets the payment date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the payment date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getProcessDateTerms
Description	Gets the process date query terms.
Return	`osid.search.terms.DateTimeRangeTerm[]`		the process date query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAmountTerms
Description	Gets the amount query terms.
Return	`osid.search.terms.CurrencyRangeTerm[]`		the amount query terms
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessIdTerms
Description	Gets the business `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the business `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessTerms
Description	Gets the business query terms.
Return	`osid.billing.BusinessQueryInspector[]`		the business query terms
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentQueryInspectorRecord
Description	Gets the payment query inspector 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.PaymentQueryInspectorRecord`		the payment query inspector 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.