Interface | osid.metering.StatisticSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getStatistics | ||
Description |
Gets the statistic list resulting from a search. | ||
Return | osid.metering.StatisticList | the statistic list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getStatisticQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.metering.StatisticQueryInspector | the statistic query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getStatisticSearchResultsRecord | ||
Description |
Gets the statistic search results record corresponding
to the given statistic search record | ||
Parameters | osid.type.Type | statisticSearchRecordType | a statistic search record type |
Return | osid.metering.records.StatisticSearchResultsRecord | the statistic search results record | |
Errors | NULL_ARGUMENT | statisticSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordTypeType(statisticSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |