OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.DepotQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among Depot objects. 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
CompliancemandatoryThis method must be implemented.
MethodgetDepotQuery
Description

Gets a depot query.

Returnosid.installation.DepotQuerya depot query
CompliancemandatoryThis method must be implemented.
MethodgetDepotsByQuery
Description

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

Parametersosid.installation.DepotQuerydepotQuerythe depot query
Returnosid.installation.DepotListthe returned DepotList
ErrorsNULL_ARGUMENT depotQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED depotQuery is not of this service
CompliancemandatoryThis method must be implemented.