Interface CockpitConfigurationService

All Known Implementing Classes:
DefaultCockpitConfigurationService

public interface CockpitConfigurationService
Service that allows to fetch existing cockpit configurations from the system. To create new configurations use ModelService.
  • Method Details

    • getComponentConfigurationsForPrincipal

      List<CockpitUIComponentConfigurationModel> getComponentConfigurationsForPrincipal(PrincipalModel principal)
      Gets the component configurations for principal. This also includes configurations for supergroups.
      Parameters:
      principal - the principal
      Returns:
      the component configurations for principal
    • getDedicatedComponentConfigurationsForPrincipal

      List<CockpitUIComponentConfigurationModel> getDedicatedComponentConfigurationsForPrincipal(PrincipalModel principal)
      Gets dedicated component configurations for principal. Supergroups are not included.
    • removeComponentConfigurations

      void removeComponentConfigurations(List<CockpitUIComponentConfigurationModel> configurations)
      Removes the given component configurations from persistence. Also deletes the related CockpitUIConfigurationMediaModel items if they are not shared with another CockpitUIComponentConfigurationModel.
      Parameters:
      configurations - the configurations that should be removed.
    • getComponentConfiguration

      CockpitUIComponentConfigurationModel getComponentConfiguration(PrincipalModel principal, String objectTemplateCode, String code)
      Gets the component configuration.
      Parameters:
      principal - the principal
      objectTemplateCode - the object template code
      code - the code
      Returns:
      the component configuration
    • getRoleNamesForPrincipal

      List<String> getRoleNamesForPrincipal(PrincipalModel principal)
      Gets the role names for principal.
      Parameters:
      principal - the principal
      Returns:
      the role names for principal