OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CyclicTimePeriodSearchSession
Implementsosid.calendaring.cycle.CyclicTimePeriodQuerySession
Description

This session provides methods for searching CyclicTimePeriod objects. The search query is constructed using the CyclicTimePeriodQuery. The cyclic time period record Type also specifies the record for the cyclic time period query.

getCyclicTimePeriodsByQuery() is the basic search method and returns a list of CyclicTimePeriods. A more advanced search may be performed with getCyclicTimePeriodsBySearch(). It accepts a CyclicTimePeriodSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCyclicTimePeriodsBySearch() returns a CyclicTimePeriodSearchResults that can be used to access the resulting CyclicTimePeriodList or be used to perform a search within the result set through CyclicTimePeriodSearch.

Cyclic time periods may have a query record indicated by their respective record types. The query record is accessed via the CyclicTimePeriodQuery.

MethodgetCyclicTimePeriodSearch
Description

Gets a cyclic time period search.

Returnosid.calendaring.cycle.CyclicTimePeriodSearchthe cyclic time period search
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodSearchOrder
Description

Gets a cyclic time period search order. The CyclicTimePeriodSearchOrder is supplied to a CyclicTimePeriodSearch to specify the ordering of results.

Returnosid.calendaring.cycle.CyclicTimePeriodSearchOrderthe cyclic time period search order
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.calendaring.cycle.CyclicTimePeriodQuerycyclicTimePeriodQuerythe cyclic time period query
osid.calendaring.cycle.CyclicTimePeriodSearchcyclicTimePeriodSearchthe cyclic time period search
Returnosid.calendaring.cycle.CyclicTimePeriodSearchResultsthe cyclic time period search results
ErrorsNULL_ARGUMENT cyclicTimePeriodQuery or cyclicTimePeriodSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED cyclicTimePeriodSearch or t imePeriodQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodQueryFromInspector
Description

Gets a cyclic time period query from an inspector. The inspector is available from a CyclicTimePeriodSearchResults.

Parametersosid.calendaring.cycle.CyclicTimePeriodQueryInspectorcyclicTimePeriodQueryInspectora cyclic time period query inspector
Returnosid.calendaring.cycle.CyclicTimePeriodQuerythe cyclic time period query
ErrorsNULL_ARGUMENT cyclicTimePeriodQueryInspector is null
UNSUPPORTED cyclicTimePeriodQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.