OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.CustomerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetCustomers
Description

Gets the customer list resulting from a search.

Returnosid.billing.CustomerListthe customer list
ErrorsILLEGAL_STATEthe customer list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCustomerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.billing.CustomerQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCustomerSearchResultsRecord
Description

Gets the customer search results record corresponding to the given customer search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypecustomerSearchRecordTypea customer search record type
Returnosid.billing.records.CustomerSearchResultsRecordthe customer search results record
ErrorsNULL_ARGUMENT customerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(customerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.