Interface InstallationUpdateSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InstallationUpdateSession
extends OsidSession

This session defines methods to manage installations.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getSiteId

Id getSiteId()

Gets the Site Id associated with this session.

Returns:

the Site Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSite

Site getSite()
      throws OperationFailedException,
PermissionDeniedException

Gets the Site associated with this session.

Returns:

the Site associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canGetInstallationUpdates

boolean canGetInstallationUpdates()

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.

Returns:

false if package updates are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

isInstallationCurrent

boolean isInstallationCurrent()
                       throws OperationFailedException,
PermissionDeniedException

Tests if the given installation is current.

Returns:

true if the installation is up to date, false otherwise

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getInstallationsToUpdate

InstallationList getInstallationsToUpdate()
                                   throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the resulting InstallationList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCurrentPackages

PackageList getCurrentPackages()
                        throws OperationFailedException,
PermissionDeniedException

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

Returns:

the next packages to install

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCurrentPackagesForInstallation

PackageList getCurrentPackagesForInstallation(Id installationId)
                                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

installationId - an Id of an Installation

Returns:

the next packages to install

Throws:

NotFoundException - installationId is not found

NullArgumentException - installationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isInstallationObsolete

boolean isInstallationObsolete()
                        throws OperationFailedException,
PermissionDeniedException

Tests if the given installation is obsolete.

Returns:

true if the installation is obsolete, false otherwise

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getObsoleteInstallations

InstallationList getObsoleteInstallations()
                                   throws OperationFailedException,
PermissionDeniedException

Gets the installations whose packages are obsolete.

Returns:

the obsolete installations

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateInstallation

void updateInstallation(Id installationId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Updates a single installation.

Parameters:

installationId - an Id of an Installation

Throws:

NotFoundException - installationId is not found

NullArgumentException - installationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

synchronizeInstallations

void synchronizeInstallations()
                       throws OperationFailedException,
PermissionDeniedException

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.