OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.ResourceSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetResources
Description

Gets the resource list resulting from a search.

Returnosid.resource.ResourceListthe resource list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetResourceQueryInspector
Description

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

Returnosid.resource.ResourceQueryInspectorthe resource query inspector
CompliancemandatoryThis 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.TyperesourceSearchRecordTypea resource search record type
Returnosid.resource.records.ResourceSearchResultsRecordthe resource search results record
ErrorsNULL_ARGUMENT resourceSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(resourceSearchRecordType) is false
CompliancemandatoryThis method must be implemented.