OSID Logo
OSID Specifications
repository package
Version 3.1.0
Interfaceosid.repository.RepositoryQuerySession
Implementsosid.OsidSession
Implemented Byosid.repository.RepositorySearchSession
Used Byosid.repository.RepositoryManager
osid.repository.RepositoryProxyManager
Description

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

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

MethodcanSearchRepositories
Description

Tests if this user can perform Repository searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetRepositoryQuery
Description

Gets a repository query.

Returnosid.repository.RepositoryQuery the repository query
Compliancemandatory This method must be implemented.
MethodgetRepositoriesByQuery
Description

Gets a list of Repositories matching the given repository query.

Parametersosid.repository.RepositoryQueryrepositoryQuery the repository query
Returnosid.repository.RepositoryList the returned RepositoryList
ErrorsNULL_ARGUMENT repositoryQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED repositoryQuery is not of this service
Compliancemandatory This method must be implemented.