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

This session defines methods to manage installations.

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

Tests if this user can get installation updates. 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 wish not to offer update operations to unauthorized users.

Returnboolean false if package updates are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodisInstallationCurrent
Description

Tests if the given installation is current.

Returnboolean true if the installation is up to date, false otherwise
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInstallationsToUpdate
Description

Gets a list of installations requiring update. This just returns installations that are out of date. getPackagesToUpdate() or getPackagesToUpdateForInstallation() should be used to acquire the packages to install.

Returnosid.installation.InstallationListthe resulting InstallationList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCurrentPackages
Description

Gets the packages to install to bring the site up to date.

Returnosid.installation.PackageListthe next packages to install
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCurrentPackagesForInstallation
Description

Gets the packages to install to bring the specified installation up to date.

Parametersosid.id.IdinstallationIdan Id of an Installation
Returnosid.installation.PackageListthe next packages to install
ErrorsNOT_FOUND installationId is not found
NULL_ARGUMENT installationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisInstallationObsolete
Description

Tests if the given installation is obsolete.

Returnboolean true if the installation is obsolete, false otherwise
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObsoleteInstallations
Description

Gets the installations whose packages are obsolete.

Returnosid.installation.InstallationListthe obsolete installations
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateInstallation
Description

Updates a single installation.

Parametersosid.id.IdinstallationIdan Id of an Installation
ErrorsNOT_FOUND installationId is not found
NULL_ARGUMENT installationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodsynchronizeInstallations
Description

Performs an auto-update by adding all new updated installations and removing of all obsolete installations on the site.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.