OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.RepositorySearch
Implementsosid.OsidSearch
Description

The interface for governing repository searches.

MethodsearchAmongRepositories
Description

Execute this search among the given list of repositories.

Parametersosid.id.IdListrepositoryIdslist of repositories
ErrorsNULL_ARGUMENT repositoryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRepositoryResults
Description

Specify an ordering to the search results.

Parametersosid.repository.RepositorySearchOrderrepositorySearchOrderrepository search order
ErrorsNULL_ARGUMENT repositorySearchOrder is null
UNSUPPORTED repositorySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRepositorySearchRecord
Description

Gets the repository search 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.RepositorySearchRecordthe repository search record
ErrorsNULL_ARGUMENT repositorySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(repositorySearchRecordType) is false
CompliancemandatoryThis method must be implemented.