| Interface | osid.billing.CategorySearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing category searches. | ||
| Method | searchAmongCategories | ||
| Description |
Execute this search among the given list of categories. | ||
| Parameters | osid.id.IdList | categoryIds | list of customers |
| Errors | NULL_ARGUMENT | categoryIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCategoryResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.billing.CategorySearchOrder | categorySearchOrder | customer search order |
| Errors | NULL_ARGUMENT | categorySearchOrder is null | |
| UNSUPPORTED | categorySearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCategorySearchRecord | ||
| Description |
Gets the category search record corresponding to the
given category search record | ||
| Parameters | osid.type.Type | categorySearchRecordType | a customer search record type |
| Return | osid.billing.records.CategorySearchRecord | the category search record | |
| Errors | NULL_ARGUMENT | categorySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(categorySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |