OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.RepositorySearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetRepositories
Description

Gets the repository list resulting from the search.

Returnosid.repository.RepositoryListthe repository list
ErrorsILLEGAL_STATEthe list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRepositoryQueryInspector
Description

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

Returnosid.repository.RepositoryQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetRepositorySearchResultsRecord
Description

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

Parametersosid.type.TyperepositorySearchRecordTypea repository search record type
Returnosid.repository.records.RepositorySearchResultsRecordthe repository search results record
ErrorsNULL_ARGUMENT repositorySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(repositorySearchRecordType) is false
CompliancemandatoryThis method must be implemented.