OSID - osid.installation.InstallationUpdateSession Service Interface Definition

Interface	osid.installation.InstallationUpdateSession
Implements	`osid.OsidSession`
Used By	`osid.installation.InstallationManager`
Used By	`osid.installation.InstallationProxyManager`
Description	This session defines methods to manage installations.
Method	getSiteId
Description	Gets the `Site` `Id` associated with this session.
Return	`osid.id.Id`		the `Site Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSite
Description	Gets the `Site` associated with this session.
Return	`osid.installation.Site`		the `Site` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canGetInstallationUpdates
Description	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.
Return	`boolean`		`false` if package updates are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isInstallationCurrent
Description	Tests if the given installation is current.
Return	`boolean`		`true` if the installation is up to date, `false` otherwise
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationsToUpdate
Description	Gets a list of installations requiring update. This just returns installations that are out of date. `getInstallationPackagesToUpdate()` or `getInstallationPackagesToUpdateForInstallation()` should be used to acquire the packages to install.
Return	`osid.installation.InstallationList`		the resulting `InstallationList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCurrentInstallationPackages
Description	Gets the packages to install to bring the site up to date.
Return	`osid.installation.InstallationPackageList`		the next packages to install
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCurrentInstallationPackagesForInstallation
Description	Gets the packages to install to bring the specified installation up to date.
Parameters	`osid.id.Id`	`installationId`	an `Id` of an `Installation`
Return	`osid.installation.InstallationPackageList`		the next packages to install
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	isInstallationObsolete
Description	Tests if the given installation is obsolete.
Return	`boolean`		`true` if the installation is obsolete, `false` otherwise
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getObsoleteInstallations
Description	Gets the installations whose packages are obsolete.
Return	`osid.installation.InstallationList`		the obsolete installations
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateInstallation
Description	Updates a single 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	synchronizeInstallations
Description	Performs an auto-update by adding all new updated installations and removing of all obsolete installations on the site.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.