OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.CustomerSearch
Implementsosid.OsidSearch
Description

The search interface for governing customer searches.

MethodsearchAmongCustomers
Description

Execute this search among the given list of customers.

Parametersosid.id.IdListcustomerIdslist of customers
ErrorsNULL_ARGUMENT customerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCustomerResults
Description

Specify an ordering to the search results.

Parametersosid.billing.CustomerSearchOrdercustomerSearchOrdercustomer search order
ErrorsNULL_ARGUMENT customerSearchOrder is null
UNSUPPORTED customerSearchOrder is not of this service
CompliancemandatoryThis 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.TypecustomerSearchRecordTypea customer search record type
Returnosid.billing.records.CustomerSearchRecordthe customer search record
ErrorsNULL_ARGUMENT customerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(customerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.