OSID Logo
OSID Specifications
repository package
Version 3.1.0
Interfaceosid.repository.RepositorySearchResults
Implementsosid.OsidSearchResults
Used Byosid.repository.RepositorySearchSession
Description

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

MethodgetRepositories
Description

Gets the repository list resulting from the search.

Returnosid.repository.RepositoryList the repository list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetRepositoryQueryInspector
Description

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

Returnosid.repository.RepositoryQueryInspector the query inspector
Compliancemandatory This 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.TyperepositorySearchRecordType a repository search record type
Returnosid.repository.records.RepositorySearchResultsRecord the repository search results record
ErrorsNULL_ARGUMENT repositorySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(repositorySearchRecordType) is false
Compliancemandatory This method must be implemented.