OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.Installation
Implementsosid.OsidObject
Description

A Installation represents a Package installed on a Site.

MethodgetSiteId
Description

Gets the Site Id in which this installation is installed.

Returnosid.id.Idthe site Id
CompliancemandatoryThis method must be implemented.
MethodgetSite
Description

Gets the Site in which this installation is installed.

Returnosid.installation.Sitethe package site
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetPackageId
Description

Gets the package Id of this installation.

Returnosid.id.Idthe package Id
CompliancemandatoryThis method must be implemented.
MethodgetPackage
Description

Gets the package.

Returnosid.installation.Packagethe package
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDepotId
Description

Gets the Id of depot from which the package was installed.

Returnosid.id.Idthe depot Id
CompliancemandatoryThis method must be implemented.
MethodgetDepot
Description

Gets the depot from which the package was installed.

Returnosid.installation.Depotthe depot
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetInstallDate
Description

Gets the date the package was installed.

Returnosid.calendaring.DateTimethe installation date
CompliancemandatoryThis method must be implemented.
MethodgetAgentId
Description

Gets the Id of the agent who installed this package.

Returnosid.id.Idthe agent Id
CompliancemandatoryThis method must be implemented.
MethodgetAgent
Description

Gets the agent who installed this package.

Returnosid.authentication.Agentthe agent
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetLastCheckDate
Description

Gets the date the installation was last checked for updates.

Returnosid.calendaring.DateTimethe last check date
CompliancemandatoryThis method must be implemented.
MethodgetInstallationRecord
Description

Gets the installation record corresponding to the given Installation record Type. This method is used to retrieve an object implementing the requested record. The installationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(installationRecordType) is true .

Parametersosid.type.TypeinstallationRecordTypethe type of the record to retrieve
Returnosid.installation.records.InstallationRecordthe installation record
ErrorsNULL_ARGUMENT installationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(installationRecordType) is false
CompliancemandatoryThis method must be implemented.