OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.StatisticSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetStatistics
Description

Gets the statistic list resulting from a search.

Returnosid.metering.StatisticListthe statistic list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetStatisticQueryInspector
Description

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

Returnosid.metering.StatisticQueryInspectorthe statistic query inspector
CompliancemandatoryThis method must be implemented.
MethodgetStatisticSearchResultsRecord
Description

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

Parametersosid.type.TypestatisticSearchRecordTypea statistic search record type
Returnosid.metering.records.StatisticSearchResultsRecordthe statistic search results record
ErrorsNULL_ARGUMENT statisticSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(statisticSearchRecordType) is false
CompliancemandatoryThis method must be implemented.