OSID Logo
OSID Specifications
calendaring cycle package
Version 3.1.0
Interfaceosid.calendaring.cycle.CyclicTimePeriodSearchResults
Implementsosid.OsidSearchResults
Used Byosid.calendaring.cycle.CyclicTimePeriodSearchSession
Description

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

MethodgetCyclicTimePeriods
Description

Gets the cyclic time period list resulting from the search.

Returnosid.calendaring.cycle.CyclicTimePeriodList the cyclic time period list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetCyclicTimePeriodQueryInspector
Description

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

Returnosid.calendaring.cycle.CyclicTimePeriodQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetCyclicTimePeriodSearchResultsRecord
Description

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

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