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

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

MethodgetCommitmentEnablers
Description

Gets the CommitmentEnablerList resulting from a search.

Returnosid.calendaring.rules.CommitmentEnablerListthe commitment enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentEnablerQueryInspector
Description

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

Returnosid.calendaring.rules.CommitmentEnablerQueryInspectorthe commitment enabler query inspector
CompliancemandatoryThis 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.TypecommitmentEnablerSearchRecordTypea commitment enabler search record type
Returnosid.calendaring.rules.records.CommitmentEnablerSearchResultsRecordthe commitment enabler search results record
ErrorsNULL_ARGUMENT commitmentEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(commitmentEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.