OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.RequestSearchResults
Implementsosid.OsidSearchResults
Used Byosid.provisioning.RequestSearchSession
Description

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

MethodgetRequests
Description

Gets the request list resulting from a search.

Returnosid.provisioning.RequestList the request list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetRequestQueryInspector
Description

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

Returnosid.provisioning.RequestQueryInspector the request query inspector
Compliancemandatory This method must be implemented.
MethodgetRequestSearchResultsRecord
Description

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

Parametersosid.type.TyperequestSearchRecordType a request search record type
Returnosid.provisioning.records.RequestSearchResultsRecord the request search results record
ErrorsNULL_ARGUMENT requestSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(requestSearchRecordType) is false
Compliancemandatory This method must be implemented.