OSID Logo
OSID Specifications
installation package
Version 3.1.0
Interfaceosid.installation.DepotQuerySession
Implementsosid.OsidSession
Implemented Byosid.installation.DepotSearchSession
Used Byosid.installation.InstallationManager
osid.installation.InstallationProxyManager
Description

This session provides methods for searching among Depots. The search query is constructed using the DepotQuery.

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

MethodcanSearchDepots
Description

Tests if this user can perform Depot 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.
MethodgetDepotQuery
Description

Gets a depot query.

Returnosid.installation.DepotQuery a depot query
Compliancemandatory This method must be implemented.
MethodgetDepotsByQuery
Description

Gets a list of Depot objects matching the given depot query.

Parametersosid.installation.DepotQuerydepotQuery the depot query
Returnosid.installation.DepotList the returned DepotList
ErrorsNULL_ARGUMENT depotQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED depotQuery is not of this service
Compliancemandatory This method must be implemented.