com.atlassian.activeobjects.external

Interface ActiveObjectsUpgradeTask

public interface ActiveObjectsUpgradeTask

This is the interface to implement for writing upgrade tasks.

Method Summary

Modifier and Type	Method and Description
ModelVersion	getModelVersion() This gives the version the upgrade task will upgrade the model to.
void	upgrade(ModelVersion currentVersion, ActiveObjects ao) Upgrades the database model of this Active Objects plugin to the given version.

Method Detail

getModelVersion

ModelVersion getModelVersion()

This gives the version the upgrade task will upgrade the model to. This is this version that is used by the Active Objects plugin to figure out whether this upgrade task should be run and in which order.

Returns:

the version of the model after the upgrade task has been run successfully.

upgrade

void upgrade(ModelVersion currentVersion,
             ActiveObjects ao)

Upgrades the database model of this Active Objects plugin to the given version.

If any exception is thrown during the upgrade then sub-sequent upgrades won't run and this upgrade task will be re-tried next time.

Parameters:

currentVersion - the current version of the model currently in the database.

ao - a configured instance of the Active Objects, which is not associated with any entity (yet).