Interface | osid.installation.InstallationManagementSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to manage installations. | ||
Method | getSiteId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Site Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSite | ||
Description |
Gets the | ||
Return | osid.installation.Site | the Site associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageInstallations | ||
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 | ||
Return | boolean | false if Package installation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | installPackage | ||
Description |
Installs a package at a default site. | ||
Parameters | osid.id.Id | packageId | an Id of a Package |
Return | osid.installation.Installation | the resulting Installation | |
Errors | ALREADY_EXISTS | package is already installed | |
NOT_FOUND | packageId is not found | ||
NULL_ARGUMENT | packageId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeInstallation | ||
Description |
Removes an installation. | ||
Parameters | osid.id.Id | installationId | an Id of an Installation |
Errors | NOT_FOUND | installationId is not found | |
NULL_ARGUMENT | installationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeInstallations | ||
Description |
Removes all installations at the site. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |