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

The search interface for governing inquest searches.

MethodsearchAmongInquests
Description

Execute this search among the given list of inquests.

Parametersosid.id.IdListinquestIdslist of inquests
ErrorsNULL_ARGUMENT inquestIds is null
CompliancemandatoryThis method must be implemented.
MethodorderInquestResults
Description

Specify an ordering to the search results.

Parametersosid.inquiry.InquestSearchOrderinquestSearchOrderinquest search order
ErrorsNULL_ARGUMENT inquestSearchOrder is null
UNSUPPORTED inquestSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInquestSearchRecord
Description

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

Parametersosid.type.TypeinquestSearchRecordTypean inquest search record type
Returnosid.inquiry.records.InquestSearchRecordthe inquest search record
ErrorsNULL_ARGUMENT inquestSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inquestSearchRecordType) is false
CompliancemandatoryThis method must be implemented.