Interface StatisticSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface StatisticSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
StatisticQueryInspector	getStatisticQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
StatisticList	getStatistics()	Gets the statistic list resulting from a search.
StatisticSearchResultsRecord	getStatisticSearchResultsRecord(Type statisticSearchRecordType)	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.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getStatistics

StatisticList getStatistics()

Gets the statistic list resulting from a search.

Returns:

the statistic list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getStatisticQueryInspector

StatisticQueryInspector getStatisticQueryInspector()

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

Returns:

the statistic query inspector

Compliance:

mandatory - This method must be implemented.

getStatisticSearchResultsRecord

StatisticSearchResultsRecord getStatisticSearchResultsRecord(Type statisticSearchRecordType)
                                                      throws OperationFailedException

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.

Parameters:

statisticSearchRecordType - a statistic search record type

Returns:

the statistic search results record

Throws:

NullArgumentException - statisticSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(statisticSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.