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

This session provides methods to retrieve Package to Depot mappings. A Package may appear in multiple Depots. Each Depot may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupPackageDepotMappings
Description

Tests if this user can perform lookups of package/depot mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeDepotView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryDepotView
Description

A complete view of the Package and Depot returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

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.
MethodgetPackageIdsByDepot
Description

Gets the list of Package Ids associated with a Depot.

Parametersosid.id.IddepotId Id of the Depot
Returnosid.id.IdListlist of related package Ids
ErrorsNOT_FOUND depotId is not found
NULL_ARGUMENT depotId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackagesByDepot
Description

Gets the list of Packages associated with a Depot.

Parametersosid.id.IddepotId Id of the Depot
Returnosid.installation.PackageListlist of related packages
ErrorsNOT_FOUND depotId is not found
NULL_ARGUMENT depotId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackageIdsByDepots
Description

Gets the list of Package Ids corresponding to a list of Depots.

Parametersosid.id.IdListdepotIdslist of depot Ids
Returnosid.id.IdListlist of package Ids
ErrorsNULL_ARGUMENT depotIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackagesByDepots
Description

Gets the list of Packages corresponding to a list of Depots.

Parametersosid.id.IdListdepotIdslist of depot Ids
Returnosid.installation.PackageListlist of packages
ErrorsNULL_ARGUMENT depotIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDepotIdsByPackage
Description

Gets the list of Depot Ids mapped to a Package.

Parametersosid.id.IdpackageId Id of a Package
Returnosid.id.IdListlist of depot Ids
ErrorsNOT_FOUND packageId is not found
NULL_ARGUMENT packageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDepotsByPackage
Description

Gets the list of Depots mapped to a Package.

Parametersosid.id.IdpackageId Id of a Package
Returnosid.installation.DepotListlist of depots
ErrorsNOT_FOUND packageId is not found
NULL_ARGUMENT packageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.