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

The search interface for governing inquiry searches.

MethodsearchAmongInquiries
Description

Execute this search among the given list of inquiries.

Parametersosid.id.IdListinquiryIdslist of inquiries
ErrorsNULL_ARGUMENT inquiryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderInquiryResults
Description

Specify an ordering to the search results.

Parametersosid.inquiry.InquirySearchOrderinquirySearchOrderinquiry search order
ErrorsNULL_ARGUMENT inquirySearchOrder is null
UNSUPPORTED inquirySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInquirySearchRecord
Description

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

Parametersosid.type.TypeinquirySearchRecordTypean inquiry search record type
Returnosid.inquiry.records.InquirySearchRecordthe inquiry search record
ErrorsNULL_ARGUMENT inquirySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inquirySearchRecordType) is false
CompliancemandatoryThis method must be implemented.