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

This session provides methods for retrieving Package s from remote Depots.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated depot view: All package methods in this session operate, retrieve and pertain to packages defined explicitly in the current depot. Using an isolated view is useful for managing packages with the PackageAdminSession.
  • federated depot view: All package methods in this session operate, retrieve and pertain to all packages defined in this depot and any other depots implicitly available in this depot through depot inheritence.
  • normalized version view: multiple versions of the same package are suppressed
  • denormalized version vew: all versions of an installation are returned

Packages may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Package.

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

Tests if this user can perform Package lookups. 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 lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativePackageView
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.
MethodusePlenaryPackageView
Description

A complete view of the Package 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.
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 lookups 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.
MethodgetPackage
Description

Gets the Package specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Package may have a different Id than requested, such as the case where a duplicate Id was assigned to a Package and retained for compatibility.

Parametersosid.id.IdpackageId Id of the Package
Returnosid.installation.Packagethe package
ErrorsNOT_FOUND packageId not found
NULL_ARGUMENT packageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetPackagesByIds
Description

Gets a PackageList corresponding to the given IdList. In plenary mode, the returned list contains all of the packages specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Packages may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListpackageIdsthe list of Ids to retrieve
Returnosid.installation.PackageListthe returned Package list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT packageIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackagesByGenusType
Description

Gets a PackageList corresponding to the given package genus Type which does not include packages of genus types derived from the specified Type. In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.

Parametersosid.type.TypepackageGenusTypea package genus type
Returnosid.installation.PackageListthe returned Package list
ErrorsNULL_ARGUMENT packageGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackagesByParentGenusType
Description

Gets a PackageList corresponding to the given package genus Type and include any additional package with genus types derived from the specified Type. In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.

Parametersosid.type.TypepackageGenusTypea package genus type
Returnosid.installation.PackageListthe returned Package list
ErrorsNULL_ARGUMENT packageGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackagesByRecordType
Description

Gets a PackageList containing the given package record Type. In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.

Parametersosid.type.TypepackageRecordTypea package record type
Returnosid.installation.PackageListthe returned Package list
ErrorsNULL_ARGUMENT packageRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackagesByProvider
Description

Gets a PackageList for the given provider. In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.installation.PackageListthe returned Package list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDependentPackages
Description

Gets a list of packages depending on the given package.

Parametersosid.id.IdpackageIdan Id of a Package
Returnosid.installation.PackageListlist of package dependents
ErrorsNOT_FOUND packageId is not found
NULL_ARGUMENT packageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackageVersions
Description

Gets a list of packages in the specified package version chain.

Parametersosid.id.IdpackageIdan Id of a Package
Returnosid.installation.PackageListlist of dependencies
ErrorsNOT_FOUND packageId is not found
NULL_ARGUMENT packageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPackages
Description

Gets all Packages. In plenary mode, the returned list contains all known packages or an error results. Otherwise, the returned list may contain only those packages that are accessible through this session.

Returnosid.installation.PackageLista PackageList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.