OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.TimePeriodSearchResults
Implementsosid.OsidSearchResults
Used Byosid.calendaring.TimePeriodSearchSession
Description

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

MethodgetTimePeriods
Description

Gets the time period list resulting from the search.

Returnosid.calendaring.TimePeriodList the time period list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetTimePeriodQueryInspector
Description

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

Returnosid.calendaring.TimePeriodQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetTimePeriodSearchResultsRecord
Description

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.

Parametersosid.type.TypetimePeriodSearchRecordType a time period search record type
Returnosid.calendaring.records.TimePeriodSearchResultsRecord the time period search results record
ErrorsNULL_ARGUMENT timePeriodSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(timePeriodSearchRecordType) is false
Compliancemandatory This method must be implemented.