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

This session provides methods for searching Installations. The search query is constructed using the InstallationQuery. The installation record Type also specifies the record for the installation query.

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

MethodgetSiteId
Description

Gets the Site Id associated with this session.

Returnosid.id.Idthe Site Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSite
Description

Gets the Site associated with this session.

Returnosid.installation.Sitethe Site associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchInstallations
Description

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

The returns from the lookup methods may omit multiple versions of the same installation.

CompliancemandatoryThis method is must be implemented.
MethoduseDenormalizedVersionView
Description

All versions of the same installation are returned.

CompliancemandatoryThis method is must be implemented.
MethoduseNormalizedDependencyView
Description

A normalized view uses a single Installation to represent a set of package dependencies.

CompliancemandatoryThis method is must be implemented.
MethoduseDenormalizedDependencyView
Description

A denormalized view returns all dependencies.

CompliancemandatoryThis method is must be implemented.
MethodgetInstallationQuery
Description

Gets an installation query.

Returnosid.installation.InstallationQuerythe installation query
CompliancemandatoryThis method must be implemented.
MethodgetInstallationsByQuery
Description

Gets a list of Installations matching the given installation query.

Parametersosid.installation.InstallationQueryinstallationQuerythe installation query
Returnosid.installation.InstallationListthe returned InstallationList
ErrorsNULL_ARGUMENT installationQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED installationQuery is not of this service
CompliancemandatoryThis method must be implemented.