Interface StatisticSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface StatisticSearch
extends OsidSearch

The search interface for governing statistic searches.

Method Summary

Modifier and Type	Method	Description
StatisticSearchRecord	getStatisticSearchRecord(Type statisticSearchRecordType)	Gets the statistic search record corresponding to the given statistic search record Type.
void	orderStatisticResults(StatisticSearchOrder statisticSearchOrder)	Specify an ordering to the search results.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

orderStatisticResults

void orderStatisticResults(StatisticSearchOrder statisticSearchOrder)

Specify an ordering to the search results.

Parameters:

statisticSearchOrder - statistic search order

Throws:

NullArgumentException - statisticSearchOrder is null

UnsupportedException - statisticSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getStatisticSearchRecord

StatisticSearchRecord getStatisticSearchRecord(Type statisticSearchRecordType)
                                        throws OperationFailedException

Gets the statistic search 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 record

Throws:

NullArgumentException - statisticSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(statisticSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.