OSID Logo
OSID Specifications
installation package
Version 3.1.0
Interfaceosid.installation.InstallationQuerySession
Implementsosid.OsidSession
Implemented Byosid.installation.InstallationSearchSession
Used Byosid.installation.InstallationManager
osid.installation.InstallationProxyManager
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.Id the Site Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetSite
Description

Gets the Site associated with this session.

Returnosid.installation.Site the Site associated with this session
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethoduseNormalizedVersionView
Description

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

Compliancemandatory This method is must be implemented.
MethoduseDenormalizedVersionView
Description

All versions of the same installation are returned.

Compliancemandatory This method is must be implemented.
MethoduseNormalizedDependencyView
Description

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

Compliancemandatory This method is must be implemented.
MethoduseDenormalizedDependencyView
Description

A denormalized view returns all dependencies.

Compliancemandatory This method is must be implemented.
MethodgetInstallationQuery
Description

Gets an installation query.

Returnosid.installation.InstallationQuery the installation query
Compliancemandatory This method must be implemented.
MethodgetInstallationsByQuery
Description

Gets a list of Installations matching the given installation query.

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