OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.InstallationManagementSession
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.
MethodcanManageInstallations
Description

Tests if this user can manage installations 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 management operations to unauthorized users.

Returnboolean false if Package installation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodinstallPackage
Description

Installs a package at a default site.

Parametersosid.id.IdpackageIdan Id of a Package
Returnosid.installation.Installationthe resulting Installation
ErrorsALREADY_EXISTSpackage is already installed
NOT_FOUND packageId is not found
NULL_ARGUMENT packageId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveInstallation
Description

Removes an 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.
MethodremoveInstallations
Description

Removes all installations at the site.

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