Package de.xima.fc.update.updates.pre8

Class ThemeToFormVersionUpdate

java.lang.Object

de.xima.fc.update.updates.pre8.ThemeToFormVersionUpdate

All Implemented Interfaces:

IOrderable, ISystemUpdate, Comparable<IOrderable>

public class ThemeToFormVersionUpdate
extends Object
implements ISystemUpdate

A new column was added to the FormVersion entity: FormVersion.getTheme(). Up until version 5, the theme reference was stored directly inside the persist JSON. Starting with version 6, the theme reference receives its own database column, which makes it easier and faster to read the theme, as it does not require accessing the persist JSON file data and parsing the JSON. This update iterates over each form version without a theme (database column theme set to null), attempts to parse the persist JSON and retrieve the theme, and updates the db column theme.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
ThemeToFormVersionUpdate()

Method Summary

Modifier and Type	Method	Description
void	exec()	Executes the system update
String	getDescription(Locale loc)	Gets an Description of the update which should be shown in the ui.
String	getUUID()	Gets an String for identifying an update.
boolean	needsToRun()	Checks if an update needs to run at all.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.xima.fc.listener.IOrderable

compareTo, shouldBeAfter

Constructor Detail

ThemeToFormVersionUpdate

public ThemeToFormVersionUpdate()

Method Detail

getUUID

public String getUUID()

Description copied from interface: ISystemUpdate

Gets an String for identifying an update. This String should not be longer than 36 chars and should not be changed, otherwise the update may run multiple times!

Specified by:

getUUID in interface ISystemUpdate

Returns:

String UUID of the update

getDescription

public String getDescription(Locale loc)

Description copied from interface: ISystemUpdate

Gets an Description of the update which should be shown in the ui. The description will also be stored in the database with an max of 1020 chars and the locale CmnConst.DFLT_LOCALE

Specified by:

getDescription in interface ISystemUpdate

Parameters:

loc - Locale the current ui locale

Returns:

String

needsToRun

public boolean needsToRun()

Description copied from interface: ISystemUpdate

Checks if an update needs to run at all. If not, the update will be marked as run and never performed at all.

Specified by:

needsToRun in interface ISystemUpdate

Returns:

Boolean if the update is needed

exec

public void exec()

Description copied from interface: ISystemUpdate

Executes the system update

Specified by:

exec in interface ISystemUpdate