Package com.flowable.platform.api.configuration

Interface ConfigurationService

All Known Implementing Classes:
ConfigurationServiceImpl
public interface ConfigurationService
Author:
Filip Hrisafov

  • Method Details

    • getLanguages

      Map<String,String> getLanguages()
      The Locale mapping from browser Locale key to the key that should be used for Work and the Form engine

    • createThemeQuery

      ThemeQuery createThemeQuery()
      Create a query for querying themes

    • createThemeBuilder

      ThemeBuilder createThemeBuilder(String themeName)
      Create a theme builder for theme with the given name
      Parameters:
      themeName - the name of the theme

    • deleteTheme

      void deleteTheme(String themeId)
      Delete the theme with the given id.
      Parameters:
      themeId - the id of the theme that should be deleted

    • setDefaultThemeName

      void setDefaultThemeName(String themeName, String tenantId)
      Set the default theme name for the given tenant
      Parameters:
      themeName - the name of the default theme
      tenantId - the id of the tenant

    • getDefaultThemeName

      String getDefaultThemeName(String tenantId)
      Get the default theme name for the given tenant
      Parameters:
      tenantId - the id of the tenant
      Returns:
      the name of the default theme

    • createDataTableFavoriteConfigurationQuery

      DataTableFavoriteConfigurationQuery createDataTableFavoriteConfigurationQuery()
      Create a query for querying data table configurations.

    • createDataTableFavoriteConfigurationBuilder

      DataTableFavoriteConfigurationBuilder createDataTableFavoriteConfigurationBuilder(String favoriteKey)
      Create a data table favorite configuration builder with the given favorite key.
      Parameters:
      favoriteKey - the key of the favorite

    • createUpdateDataTableFavoriteConfigurationBuilder

      DataTableFavoriteConfigurationBuilder createUpdateDataTableFavoriteConfigurationBuilder(String favoriteKey, String configurationId)
      Create an update data table favorite configuration builder with the given key and configuration id.
      Parameters:
      favoriteKey - the key of the configuration
      configurationId - the id of the configuration

    • deleteDataTableFavoriteConfiguration

      void deleteDataTableFavoriteConfiguration(String configurationId)
      Delete the favorite with the given id.
      Parameters:
      configurationId - the id of the favorite that should be deleted

    • createSystemConfigurationQuery

      SystemConfigurationQuery createSystemConfigurationQuery()
      Create a query for querying system configuration.

    • createSystemConfigurationBuilder

      SystemConfigurationBuilder createSystemConfigurationBuilder(String type)
      Create a system configuration builder with the given type.
      Parameters:
      type - the type of the system configuration

    • createUpdateSystemConfigurationBuilder

      SystemConfigurationBuilder createUpdateSystemConfigurationBuilder(String configurationId)
      Create an update system configuration builder with the given configuration id
      Parameters:
      configurationId - the id of the configuration

    • deleteSystemConfiguration

      void deleteSystemConfiguration(String configurationId)
      Delete the system configuration with the given id.
      Parameters:
      configurationId - the id of the system configuration that should be deleted

    • createConfigurationPropertyQuery

      ConfigurationPropertyQuery createConfigurationPropertyQuery()
      Create a query for configuration properties

    • createConfigurationPropertyBuilder

      ConfigurationPropertyBuilder createConfigurationPropertyBuilder(String namespace, String name)
      Create a builder for a configuration property. Using this builder will always create a new property.
      Parameters:
      namespace - the mandatory namespace for the configuration
      name - the mandatory name for the configuration

    • createUpdateConfigurationPropertyBuilder

      ConfigurationPropertyBuilder createUpdateConfigurationPropertyBuilder(String configurationId)
      Create an update builder for a configuration property. Using this builder will always update the configuration property for the given id.
      Parameters:
      configurationId - the id of the configuration that should be updated

    • deleteConfigurationProperty

      void deleteConfigurationProperty(String configurationId)
      Delete the configuration property with the given id.

    • setOwner

      void setOwner(String configurationId, String userId)
      Add an identity link of the given type between the configuration with the given id and the user.
      Parameters:
      configurationId - the id of the configuration
      userId - the id of the user