OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CyclicTimePeriodSearch
Implementsosid.OsidSearch
Description

CyclicTimePeriodSearch defines the interface for specifying cyclic time period search options.

MethodsearchAmongCyclicTimePeriods
Description

Execute this search among the given list of cyclic time periods.

Parametersosid.id.IdListcyclicTimePeriodIdslist of cyclic time periods
ErrorsNULL_ARGUMENT cyclicTimePeriodIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCyclicTimePeriodResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.cycle.CyclicTimePeriodSearchOrdercyclicTimePeriodSearchOrdercyclic time period search order
ErrorsNULL_ARGUMENT cyclicTimePeriodSearchOrder is null
UNSUPPORTED cyclicTimePeriodSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodSearchRecord
Description

Gets the cyclic time period search 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.CyclicTimePeriodSearchRecordthe cyclic time period search record
ErrorsNULL_ARGUMENT cyclicTimePeriodSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(cyclicTimePeriodSearchRecordType) is false
CompliancemandatoryThis method must be implemented.