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

The search interface for governing category searches.

MethodsearchAmongCategories
Description

Execute this search among the given list of categories.

Parametersosid.id.IdListcategoryIdslist of customers
ErrorsNULL_ARGUMENT categoryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCategoryResults
Description

Specify an ordering to the search results.

Parametersosid.billing.CategorySearchOrdercategorySearchOrdercustomer search order
ErrorsNULL_ARGUMENT categorySearchOrder is null
UNSUPPORTED categorySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCategorySearchRecord
Description

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

Parametersosid.type.TypecategorySearchRecordTypea customer search record type
Returnosid.billing.records.CategorySearchRecordthe category search record
ErrorsNULL_ARGUMENT categorySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(categorySearchRecordType) is false
CompliancemandatoryThis method must be implemented.