OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.InquiryEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetInquiryEnablers
Description

Gets the InquiryEnablerList resulting from a search.

Returnosid.inquiry.rules.InquiryEnablerListthe inquiry enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetInquiryEnablerQueryInspector
Description

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

Returnosid.inquiry.rules.InquiryEnablerQueryInspectorthe inquiry enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetInquiryEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypeinquiryEnablerSearchRecordTypean inquiry enabler search record type
Returnosid.inquiry.rules.records.InquiryEnablerSearchResultsRecordthe inquiry enabler search results record
ErrorsNULL_ARGUMENT inquiryEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(inquiryEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.