Interface | osid.billing.CustomerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing customer searches. | ||
Method | searchAmongCustomers | ||
Description |
Execute this search among the given list of customers. | ||
Parameters | osid.id.IdList | customerIds | list of customers |
Errors | NULL_ARGUMENT | customerIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderCustomerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.billing.CustomerSearchOrder | customerSearchOrder | customer search order |
Errors | NULL_ARGUMENT | customerSearchOrder is null | |
UNSUPPORTED | customerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCustomerSearchRecord | ||
Description |
Gets the customer search record corresponding to the
given customer search record | ||
Parameters | osid.type.Type | customerSearchRecordType | a customer search record type |
Return | osid.billing.records.CustomerSearchRecord | the customer search record | |
Errors | NULL_ARGUMENT | customerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(customerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |