OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CyclicTimePeriodSearchResults
Implementsosid.OsidSearchResults
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.CyclicTimePeriodListthe cyclic time period list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis 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.CyclicTimePeriodQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypecyclicTimePeriodSearchRecordTypea cyclic time period search record type
Returnosid.calendaring.cycle.records.CyclicTimePeriodSearchResultsRecordthe cyclic time period search results record
ErrorsNULL_ARGUMENT cyclicTimePeriodSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cyclicTimePeriodSearchRecordType) is false
CompliancemandatoryThis method must be implemented.