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

This session provides methods for searching Package objects. The search query is constructed using the PackageQuery. The package record Type also specifies the record for the package query.

This session defines views that offer differing behaviors for searching.

  • federated depot view: searches include packages in depots of which this depot is a ancestor in the depot hierarchy
  • isolated depot view: searches are restricted to packages in this depot
  • normalized version view: multiple versions of the same package are suppressed
  • denormalized version vew: all versions of an installation are returned
  • normalized dependency view: supporting installations upon which other installations depend are suppressed
  • denormalized dependency view: all dependencies are returned

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

MethodgetDepotId
Description

Gets the Depot Id associated with this session.

Returnosid.id.Idthe Depot Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDepot
Description

Gets the Depot associated with this session.

Returnosid.installation.Depotthe Depot associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchPackages
Description

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

Federates the view for methods in this session. A federated view will include packages in depots which are children of this depot in the depot hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedDepotView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this depot only.

CompliancemandatoryThis method is must be implemented.
MethoduseNormalizedVersionView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseDenormalizedVersionView
Description

All versions of the same package are returned.

CompliancemandatoryThis method is must be implemented.
MethoduseNormalizedDependencyView
Description

A normalized view uses a single Package 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.
MethodgetPackageQuery
Description

Gets a package query.

Returnosid.installation.PackageQuerythe package query
CompliancemandatoryThis method must be implemented.
MethodgetPackagesByQuery
Description

Gets a list of Packages matching the given package query.

Parametersosid.installation.PackageQuerypackageQuerythe package query
Returnosid.installation.PackageListthe returned PackageList
ErrorsNULL_ARGUMENT packageQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED packageQuery is not of this service
CompliancemandatoryThis method must be implemented.