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

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

MethodgetCommitments
Description

Gets the commitment list resulting from the search.

Returnosid.calendaring.CommitmentListthe commitment list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentQueryInspector
Description

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

Returnosid.calendaring.CommitmentQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentSearchResultsRecord
Description

Gets the commitment search results record corresponding to the given commitment search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypecommitmentSearchRecordTypea commitment search record type
Returnosid.calendaring.records.CommitmentSearchResultsRecordthe commitment search results record
ErrorsNULL_ARGUMENT commitmentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commitmentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.