Interface TimePeriodSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface TimePeriodSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
TimePeriodQueryInspector	getTimePeriodQueryInspector()	Gets the inspector for the query to examine the time periods used in the search.
TimePeriodList	getTimePeriods()	Gets the time period list resulting from the search.
TimePeriodSearchResultsRecord	getTimePeriodSearchResultsRecord(Type timePeriodSearchRecordType)	Gets the time period search results record corresponding to the given time period 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

getTimePeriods

TimePeriodList getTimePeriods()

Gets the time period list resulting from the search.

Returns:

the time period list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getTimePeriodQueryInspector

TimePeriodQueryInspector getTimePeriodQueryInspector()

Gets the inspector for the query to examine the time periods used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getTimePeriodSearchResultsRecord

TimePeriodSearchResultsRecord getTimePeriodSearchResultsRecord(Type timePeriodSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

timePeriodSearchRecordType - a time period search record type

Returns:

the time period search results record

Throws:

NullArgumentException - timePeriodSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(timePeriodSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.