OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.OffsetEventSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetOffsetEvents
Description

Gets the offset event list resulting from the search.

Returnosid.calendaring.OffsetEventListthe offset event list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventQueryInspector
Description

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

Returnosid.calendaring.OffsetEventQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetOffsetEventSearchResultsRecord
Description

Gets the offset event search results record corresponding to the given offset event search record Type.

Parametersosid.type.TypeoffsetEventSearchRecordTypean offset event search record type
Returnosid.calendaring.records.OffsetEventSearchResultsRecordthe offset event search results record
ErrorsNULL_ARGUMENT offsetEventSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offsetEventSearchRecordType) is false
CompliancemandatoryThis method must be implemented.