OSID Logo
OSID Specifications
calendaring rules package
Version 3.1.0
Interfaceosid.calendaring.rules.CommitmentEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.calendaring.rules.CommitmentEnablerSearchSession
Description

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

MethodgetCommitmentEnablers
Description

Gets the CommitmentEnablerList resulting from a search.

Returnosid.calendaring.rules.CommitmentEnablerList the commitment enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetCommitmentEnablerQueryInspector
Description

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

Returnosid.calendaring.rules.CommitmentEnablerQueryInspector the commitment enabler query inspector
Compliancemandatory This method must be implemented.
MethodgetCommitmentEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypecommitmentEnablerSearchRecordType a commitment enabler search record type
Returnosid.calendaring.rules.records.CommitmentEnablerSearchResultsRecord the commitment enabler search results record
ErrorsNULL_ARGUMENT commitmentEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(commitmentEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.