OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.TimePeriodSearchSession
Implementsosid.calendaring.TimePeriodQuerySession
Description

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

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

Time periods may have a query record indicated by their respective record types. The query record is accessed via the TimePeriodQuery.

MethodgetTimePeriodSearch
Description

Gets a time period search.

Returnosid.calendaring.TimePeriodSearchthe time period search
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodSearchOrder
Description

Gets a time period search order. The TimePeriodSearchOrder is supplied to a TimePeriodSearch to specify the ordering of results.

Returnosid.calendaring.TimePeriodSearchOrderthe time period search order
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodsBySearch
Description

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

Parametersosid.calendaring.TimePeriodQuerytimePeriodQuerythe time period query
osid.calendaring.TimePeriodSearchtimePeriodSearchthe time period search
Returnosid.calendaring.TimePeriodSearchResultsthe time period search results
ErrorsNULL_ARGUMENT timePeriodQuery or timePeriodSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED timePeriodSearch or t imePeriodQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodQueryFromInspector
Description

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

Parametersosid.calendaring.TimePeriodQueryInspectortimePeriodQueryInspectora time period query inspector
Returnosid.calendaring.TimePeriodQuerythe time period query
ErrorsNULL_ARGUMENT timePeriodQueryInspector is null
UNSUPPORTED timePeriodQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.