OSID Logo
OSID Specifications
calendaring cycle package
Version 3.1.0
Interfaceosid.calendaring.cycle.CyclicTimePeriodQueryInspector
Implementsosid.OsidObjectQueryInspector
Used Byosid.OsidEnablerQueryInspector
osid.calendaring.cycle.CyclicTimePeriodSearchResults
osid.calendaring.cycle.CyclicTimePeriodSmartCalendarSession
osid.offering.CanonicalUnitQueryInspector
Description

This is the query inspector for examining cyclic time period queries.

Like all OsidQueryInspectors, CyclicTimePeriodQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetTimePeriodIdTerms
Description

Gets the time period Id terms.

Returnosid.search.terms.IdTerm[] the time period Id terms
Compliancemandatory This method must be implemented.
MethodgetTimePeriodTerms
Description

Gets the time period terms.

Returnosid.calendaring.TimePeriodQueryInspector[] the time period terms
Compliancemandatory This method must be implemented.
MethodgetCalendarIdTerms
Description

Gets the calendar Id terms.

Returnosid.search.terms.IdTerm[] the calendar Id terms
Compliancemandatory This method must be implemented.
MethodgetCalendarTerms
Description

Gets the calendar terms.

Returnosid.calendaring.CalendarQueryInspector[] the calendar terms
Compliancemandatory This method must be implemented.
MethodgetCyclicTimePeriodQueryInspectorRecord
Description

Gets the cyclic time period query record interface corresponding to the given CyclicTimePeriod record Type.

Parametersosid.type.TypecyclicTimePeriodRecordType a cyclic time period query record type
Returnosid.calendaring.cycle.records.CyclicTimePeriodQueryInspectorRecord the cyclic time period query inspector record
ErrorsNULL_ARGUMENT cyclicTimePeriodRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(cyclicTimePeriodRecordType) is false
Compliancemandatory This method must be implemented.