OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.RepositorySearchSession
Implementsosid.repository.RepositoryQuerySession
Description

This session provides methods for searching among Repository objects. The search query is constructed using the RepositoryQuery.

getRepositoriesByQuery() is the basic search method and returns a list of Repository objects.A more advanced search may be performed with getRepositoriesBySearch(). It accepts a RepositorySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRepositoriesBySearch() returns a RepositorySearchResults that can be used to access the resulting RepositoryList or be used to perform a search within the result set through RepositorySearch.

Repositories may have a query record indicated by their respective record types. The query record is accessed via the RepositoryQuery.

MethodgetRepositorySearch
Description

Gets a repository search.

Returnosid.repository.RepositorySearchthe repository search
CompliancemandatoryThis method must be implemented.
MethodgetRepositorySearchOrder
Description

Gets a repository search order. The RepositorySearchOrder is supplied to a RepositorySearch to specify the ordering of results.

Returnosid.repository.RepositorySearchOrderthe repository search order
CompliancemandatoryThis method must be implemented.
MethodgetRepositoriesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.repository.RepositoryQueryrepositoryQuerythe repository query
osid.repository.RepositorySearchrepositorySearchthe repository search
Returnosid.repository.RepositorySearchResultsthe repository search results
ErrorsNULL_ARGUMENT repositoryQuery or repositorySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED repositoryQuery or repositorySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRepositoryQueryFromInspector
Description

Gets a repository query from an inspector. The inspector is available from a RepositorySearchResults.

Parametersosid.repository.RepositoryQueryInspectorrepositoryQueryInspectora repository query inspector
Returnosid.repository.RepositoryQuerythe repository query
ErrorsNULL_ARGUMENT repositoryQueryInspector is null
UNSUPPORTED repositoryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.