OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.CategorySearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetCategories
Description

Gets the category list resulting from a search.

Returnosid.billing.CategoryListthe category list
ErrorsILLEGAL_STATEthe category list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCategoryQueryInspector
Description

Gets the inspector for the query to examine the periods used in the search.

Returnosid.billing.CategoryQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCategorySearchResultsRecord
Description

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

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