ISystemUpdate (FORMCYCLE: BOM 7.0.5 API)

All Superinterfaces:

Comparable<IOrderable>, IOrderable

All Known Implementing Classes:

AddAuthenticatorsUpdate_6_4, AuthTemplateUpdate_6_4, ClearAndUpdateDatatablesUpdate_6_0, CSVSourcesMigrationUpdate, DeprecateTextTemplateSystemInfoUpdate_7_0, EncryptTemplateI18nUpdate_6_4, FileFormRecordDataSizeUpdate_6_0, FixMissingInvalidTokenTemplate_6_6_9, FormVersionUpdate_6_1, I18nVariableMigrationUpdate, PluginToDatabaseUpdate, ProcessingUpdate_6_1, ProcessingUpdate_6_2, ProjectIdentityCheckDataUpdate_7_0, ProjectInboxUpdate_6_4, ProjectPasswordMigration_7_0, ReinitialzeMySQLProjectTables_6_0, RoleAccessPropertyUpdate_6_0, RoleAccessPropertyUpdate_6_1, RoleAccessPropertyUpdate_6_2, RoleAccessPropertyUpdate_6_4, RoleAccessPropertyUpdate_6_5, RoleAccessPropertyUpdate_6_6_1, RoleAccessPropertyUpdate_7_0, TemplateUpdate_6_5, TextTemplates_6_0, ThemeToFormVersionUpdate, WorkflowStateRecordRestrictionUpdate_7_0_5
```
public interface ISystemUpdate
extends IOrderable
```
Interfaces for system changes

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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.
`default boolean`	`needsToRun()`	Checks if an update needs to run at all.

Methods inherited from interface de.xima.fc.listener.IOrderable
compareTo, shouldBeAfter

- Method Detail
  - getUUID
```
String getUUID()
```
    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!
    
    Returns:
    
    String UUID of the update
  - getDescription
```
String getDescription(Locale loc)
```
    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
    
    Parameters:
    
    loc - Locale the current ui locale
    
    Returns:
    
    String
  - needsToRun
```
default boolean needsToRun()
```
    Checks if an update needs to run at all. If not, the update will be marked as run and never performed at all.
    
    Returns:
    
    Boolean if the update is needed
  - exec
```
void exec()
```
    Executes the system update