OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.InquiryEnablerSearch
Implementsosid.OsidSearch
Description

The search interface for governing inquiry enabler searches.

MethodsearchAmongInquiryEnablers
Description

Execute this search among the given list of inquiry enablers.

Parametersosid.id.IdListinquiryEnablerIdslist of inquiry enablers
ErrorsNULL_ARGUMENT inquiryEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderInquiryEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.inquiry.rules.InquiryEnablerSearchOrderinquiryEnablerSearchOrderinquiry enabler search order
ErrorsNULL_ARGUMENT inquiryEnablerSearchOrder is null
UNSUPPORTED inquiryEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInquiryEnablerSearchRecord
Description

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

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