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

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

MethodgetBusinesses
Description

Gets the business list resulting from a search.

Returnosid.billing.BusinessListthe business list
ErrorsILLEGAL_STATEthe business list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBusinessQueryInspector
Description

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

Returnosid.billing.BusinessQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBusinessSearchResultsRecord
Description

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

Parametersosid.type.TypebusinessSearchRecordTypea business search record type
Returnosid.billing.records.BusinessSearchResultsRecordthe business search results record
ErrorsNULL_ARGUMENT businessSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(businessSearchRecordType) is false
CompliancemandatoryThis method must be implemented.