org.osid.calendaring

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

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.