OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.ResourceSearchResults
Implementsosid.OsidSearchResults
Used Byosid.resource.ResourceSearchSession
Description

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

MethodgetResources
Description

Gets the resource list resulting from a search.

Returnosid.resource.ResourceList the resource list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetResourceQueryInspector
Description

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

Returnosid.resource.ResourceQueryInspector the resource query inspector
Compliancemandatory This method must be implemented.
MethodgetResourceSearchResultsRecord
Description

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

Parametersosid.type.TyperesourceSearchRecordType a resource search record type
Returnosid.resource.records.ResourceSearchResultsRecord the resource search results record
ErrorsNULL_ARGUMENT resourceSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(resourceSearchRecordType) is false
Compliancemandatory This method must be implemented.