OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.CommitmentSearchResults
Implementsosid.OsidSearchResults
Used Byosid.calendaring.CommitmentSearchSession
Description

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

MethodgetCommitments
Description

Gets the commitment list resulting from the search.

Returnosid.calendaring.CommitmentList the commitment list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetCommitmentQueryInspector
Description

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

Returnosid.calendaring.CommitmentQueryInspector the query inspector
Compliancemandatory This 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.TypecommitmentSearchRecordType a commitment search record type
Returnosid.calendaring.records.CommitmentSearchResultsRecord the commitment search results record
ErrorsNULL_ARGUMENT commitmentSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(commitmentSearchRecordType) is false
Compliancemandatory This method must be implemented.