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

Class I18nVariableMigrationUpdate

java.lang.Object

de.xima.fc.update.updates.pre8.I18nVariableMigrationUpdate

All Implemented Interfaces:

IOrderable, ISystemUpdate, Comparable<IOrderable>

public class I18nVariableMigrationUpdate
extends Object
implements ISystemUpdate

System update for migration old text-templates 'FD2_I18N' to new 'I18N_VARIABLE' templates.

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_DEFAULT

Constructor Summary

Constructors

Constructor	Description
I18nVariableMigrationUpdate()

Method Summary

Modifier and Type	Method	Description
void	exec()	Executes the system update
String	getDescription(Locale loc)	Gets a description of the update which should be shown in the UI.
String	getUUID()	Gets a string for identifying the update.
SystemUpdateVersion	getVersion()	Gets the formcycle version where the update was introduced.
boolean	needsToRun()	Checks if a template from type "I18N_VARIABLE" exists for every cleint in the system.

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

Field Detail

KEY_DEFAULT

public static final String KEY_DEFAULT

See Also:

Constant Field Values

Constructor Detail

I18nVariableMigrationUpdate

public I18nVariableMigrationUpdate()

Method Detail

getUUID

public String getUUID()

Description copied from interface: ISystemUpdate

Gets a string for identifying the 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 a description of the update which should be shown in the UI. The description will also be stored in the database with a maximum of 1020 chars and the locale CmnConst.DFLT_LOCALE

Specified by:

getDescription in interface ISystemUpdate

Parameters:

loc - Locale the current ui locale

Returns:

String

getVersion

public SystemUpdateVersion getVersion()

Description copied from interface: ISystemUpdate

Gets the formcycle version where the update was introduced. System updates are run in order of their version. Updates with the same version do not have any order by default, but can be ordered by placing a SequenceOrder annotation at the class level.

Specified by:

getVersion in interface ISystemUpdate

Returns:

The formcycle version of this update.

needsToRun

public boolean needsToRun()

Checks if a template from type "I18N_VARIABLE" exists for every cleint in the system. If not, a new template of type "I18N_VARIABLE" with the values from the text template with message code "FD2_I18N" will be created.

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