OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.PayerSearchSession
Implementsosid.billing.payment.PayerQuerySession
Description

This session provides methods for searching among Payer objects. The search query is constructed using the PayerQuery.

getPayersByQuery() is the basic search method and returns a list of Payers. A more advanced search may be performed with getPayersBySearch(). It accepts a PayerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPayersBySearch() returns a PayerSearchResults that can be used to access the resulting PayerList or be used to perform a search within the result set through PayerSearch.

This session defines views that offer differing behaviors for searching.

  • federated business view: searches include payers in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to payers in this business

Payers may have a query record indicated by their respective record types. The query record is accessed via the PayerQuery.

MethodgetPayerSearch
Description

Gets a payer search.

Returnosid.billing.payment.PayerSearchthe payer search
CompliancemandatoryThis method must be implemented.
MethodgetPayerSearchOrder
Description

Gets a payer search order. The PayerSearchOrder is supplied to a PayerSearch to specify the ordering of results.

Returnosid.billing.payment.PayerSearchOrderthe payer search order
CompliancemandatoryThis method must be implemented.
MethodgetPayersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.billing.payment.PayerQuerypayerQuerythe payer query
osid.billing.payment.PayerSearchpayerSearchthe payer search
Returnosid.billing.payment.PayerSearchResultsthe payer search results
ErrorsNULL_ARGUMENT payerQuery or payerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED payerQuery or payerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPayerQueryFromInspector
Description

Gets a payer query from an inspector. The inspector is available from a PayerSearchResults.

Parametersosid.billing.payment.PayerQueryInspectorpayerQueryInspectora payer query inspector
Returnosid.billing.payment.PayerQuerythe payer query
ErrorsNULL_ARGUMENT payerQueryInspector is null
UNSUPPORTED payerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.