public interface InstallationUpdateSession extends OsidSession
This session defines methods to manage installations.
Modifier and Type | Method and Description |
---|---|
boolean |
canGetInstallationUpdates()
Tests if this user can get installation updates.
|
PackageList |
getCurrentPackages()
Gets the packages to install to bring the site up to date.
|
PackageList |
getCurrentPackagesForInstallation(Id installationId)
Gets the packages to install to bring the specified installation up to
date.
|
InstallationList |
getInstallationsToUpdate()
Gets a list of installations requiring update.
|
InstallationList |
getObsoleteInstallations()
Gets the installations whose packages are obsolete.
|
Site |
getSite()
Gets the
Site associated with this session. |
Id |
getSiteId()
Gets the
Site Id associated with this
session. |
boolean |
isInstallationCurrent()
Tests if the given installation is current.
|
boolean |
isInstallationObsolete()
Tests if the given installation is obsolete.
|
void |
synchronizeInstallations()
Performs an auto-update by adding all new updated installations and
removing of all obsolete installations on the site.
|
void |
updateInstallation(Id installationId)
Updates a single installation.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSiteId()
Site
Id
associated with this
session. Site Id
associated with this sessionmandatory
- This method must be implemented. Site getSite() throws OperationFailedException, PermissionDeniedException
Site
associated with this session. Site
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canGetInstallationUpdates()
PERMISSION_DENIED.
This is intended as a hint to an
application that may wish not to offer update operations to
unauthorized users. false
if package updates are not authorized,
true
otherwisemandatory
- This method must be implemented. boolean isInstallationCurrent() throws OperationFailedException, PermissionDeniedException
true
if the installation is up to date,
false
otherwiseOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InstallationList getInstallationsToUpdate() throws OperationFailedException, PermissionDeniedException
getPackagesToUpdate()
or getPackagesToUpdateForInstallation()
should
be used to acquire the packages to install. InstallationList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PackageList getCurrentPackages() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PackageList getCurrentPackagesForInstallation(Id installationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
installationId
- an Id
of an Installation
NotFoundException
- installationId
is
not foundNullArgumentException
- installationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean isInstallationObsolete() throws OperationFailedException, PermissionDeniedException
true
if the installation is obsolete,
false
otherwiseOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. InstallationList getObsoleteInstallations() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateInstallation(Id installationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
installationId
- an Id
of an Installation
NotFoundException
- installationId
is
not foundNullArgumentException
- installationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void synchronizeInstallations() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.