OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.ScheduleSearchResults
Implementsosid.OsidSearchResults
Used Byosid.calendaring.ScheduleSearchSession
osid.calendaring.ScheduleSlotSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetSchedules
Description

Gets the schedule list resulting from the search.

Returnosid.calendaring.ScheduleList the schedule list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetScheduleQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.calendaring.ScheduleQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetScheduleSearchResultsRecord
Description

Gets the schedule search results record corresponding to the given schedule search record Type.

Parametersosid.type.TypescheduleSearchRecordType a schedule search record type
Returnosid.calendaring.records.ScheduleSearchResultsRecord the schedule search results record
ErrorsNULL_ARGUMENT scheduleSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(scheduleSearchRecordType) is false
Compliancemandatory This method must be implemented.