OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.RequestSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetRequests
Description

Gets the request list resulting from a search.

Returnosid.provisioning.RequestListthe request list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRequestQueryInspector
Description

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

Returnosid.provisioning.RequestQueryInspectorthe request query inspector
CompliancemandatoryThis 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.TyperequestSearchRecordTypea request search record type
Returnosid.provisioning.records.RequestSearchResultsRecordthe request search results record
ErrorsNULL_ARGUMENT requestSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requestSearchRecordType) is false
CompliancemandatoryThis method must be implemented.