Interface ISystemUpdate

All Superinterfaces:
Comparable<IOrderable>, IOrderable
All Known Implementing Classes:
AddAuthenticatorsUpdate_6_4, AuthTemplateUpdate_6_4, ClearAndUpdateDatatablesUpdate_6_0, CreateIndirectClientAuthorizations_8_0, CreateLdapAuthenticatorsUpdate_8_0, CSVSourcesMigrationUpdate, DeactivateNtlmUpdate_8_0, DeprecateTextTemplateSystemInfoUpdate_7_0, EncryptTemplateI18nUpdate_6_4, FileFormRecordDataSizeUpdate_6_0, FixMissingInvalidTokenTemplate_6_6_9, FormThemeUpdate_8_3_CreateClientFormThemes, FormThemeUpdate_8_3_UpdateFormVersions, FormThemeUpdate_8_3_UpdateHtmlTextTemplates, FormVersionPropertiesUpdate_8_2, FormVersionUpdate_6_1, I18NVariableInputElementCounterUpdate_8_1, I18nVariableMigrationUpdate, InitMimeCheckActivationUpdate_8_1, KerberosConfigMigrationUpdate_8_0_4, MigrateClientLdapData_8_0, MigrateFsKeyStoresToDatabase, MigrateMfaSettingsToDatabase_8_4, MigrateOldWorkflowUserReferencesUpdate_8, MigrateUserGroupReferencesInFormDesignerToUuid_8_0_4, MigrateUsersUpdate_8_0, MigrateWorkflowUserReferencesUpdate_8_0, PluginToDatabaseUpdate, ProcessingUpdate_6_1, ProcessingUpdate_6_2, ProjectDefaultLocaleUpdate_8_3, ProjectIdentityCheckDataUpdate_7_0, ProjectInboxUpdate_6_4, ProjectPasswordMigration_7_0, PropertiesToDatabaseUpdate_8_1, ReinitialzeMySQLProjectTables_6_0, RenameQuartzTriggerJobName_8_0, RoleAccessPropertyUpdate_6_0, RoleAccessPropertyUpdate_6_1, RoleAccessPropertyUpdate_6_2, RoleAccessPropertyUpdate_6_4, RoleAccessPropertyUpdate_6_5, RoleAccessPropertyUpdate_6_6_1, RoleAccessPropertyUpdate_7_0, RoleAccessPropertyUpdate_7_0_11, RoleAccessPropertyUpdate_7_0_13, RoleAccessPropertyUpdate_7_1, RoleAccessPropertyUpdate_7_2, RoleAccessPropertyUpdate_7_3, RoleAccessPropertyUpdate_7_4, RoleAccessPropertyUpdate_8_0, RoleAccessPropertyUpdate_8_0_2, RoleAccessPropertyUpdate_8_2, RoleAccessPropertyUpdate_8_3, RoleAccessPropertyUpdate_8_4, RoleAccessPropertyUpdate_8_4_1, RoleAccessPropertyUpdate_8_5, SystemAuthenticatorClientRestrictionFlagUpdate_8_1, TemplateUpdate_6_5, TemplateUpdate_8_0, TextTemplates_6_0, ThemeToFormVersionUpdate, WorkflowStateReceivedRefactor_7_0_13, WorkflowStateRecordRestrictionUpdate_7_0_5
public interface ISystemUpdate extends IOrderable
Interfaces for system changes
Author:
XIMA MEDIA GmbH

  • Method Details

    • getUUID

      String getUUID()
      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!
      Returns:
      String UUID of the update

    • getDescription

      String getDescription(Locale loc)
      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
      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

    • getVersion

      SystemUpdateVersion getVersion()
      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.
      Returns:
      The formcycle version of this update.