OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.CustomerSearch
Implementsosid.OsidSearch
Used Byosid.billing.CustomerSearchSession
Description

The search interface for governing customer searches.

MethodsearchAmongCustomers
Description

Execute this search among the given list of customers.

Parametersosid.id.IdListcustomerIds list of customers
ErrorsNULL_ARGUMENT customerIds is null
Compliancemandatory This method must be implemented.
MethodorderCustomerResults
Description

Specify an ordering to the search results.

Parametersosid.billing.CustomerSearchOrdercustomerSearchOrder customer search order
ErrorsNULL_ARGUMENT customerSearchOrder is null
UNSUPPORTED customerSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetCustomerSearchRecord
Description

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

Parametersosid.type.TypecustomerSearchRecordType a customer search record type
Returnosid.billing.records.CustomerSearchRecord the customer search record
ErrorsNULL_ARGUMENT customerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(customerSearchRecordType) is false
Compliancemandatory This method must be implemented.