Package com.e1c.g5.v8.dt.internal.check.settings

Interface IProjectCheckSettingsProfileStore

All Known Implementing Classes:
JSONCheckSettingsProfileStore
public interface IProjectCheckSettingsProfileStore
The store that stores project's check settinfs profiles as well as corresponding project settings

  • Method Details

    • deleteProfile

      void deleteProfile(String profileName)
      Deletes the given profile from the store. Ignores non-existing profile names quietly
      Parameters:
      profileName - The name of the profile to delete. May not be null

    • duplicateProfile

      void duplicateProfile(String sourceProfileName, String destinationProfileName)
      Duplicates given profile and names it accordingly
      Parameters:
      sourceProfileName - The source profile name. May not be null
      destinationProfileName - The destination profile name. May not be null. Must be unqique among currently registered profiles

    • exportSettingsProfile

      void exportSettingsProfile(String profileName, Path destinationPath)
      Exports an existing settings profile into the selected destination file The operation quietly replaces the existing file in the destination folder if any.
      Parameters:
      profileName - The name of the profile. May not be null
      destinationPath - The destination path to write the profile into. It'a full file path, not a folder. May not be null

    • getActiveProfileName

      String getActiveProfileName()
      Gets the name of the active profile.
      Returns:
      The name of the active profile. May be null in case if the active profile still not set/data is cleared

    • getExistingProfileNames

      List<String> getExistingProfileNames()
      Gets the names of existing profiles
      Returns:
      The list of existing profile names. Never null

    • importSettingsProfile

      void importSettingsProfile(Path sourcePath)
      Imports an external settings profile into the project's set of profiles. The operation quietly replaces the existing file if any.
      Parameters:
      sourcePath - The path to the profile. May not be null

    • load

      Map<CheckUid,ProfileCheckSettingsData> load(String profileName)
      Loads the data from the store (if exists)
      Parameters:
      profileName - The name of the profile. May not be null
      Returns:
      The profile's data. Never null

    • renameProfile

      void renameProfile(String currentProfileName, String newProfileName)
      Renames the settings profile using the provided name.
      Parameters:
      currentProfileName - Current name of the profile. May not be null
      newName - The new name of the profile. May not be null

    • save

      void save(Map<CheckUid,ProfileCheckSettingsData> settingsData, String profileName)
      Saves the given data to the given profile
      Parameters:
      settingsData - The data to save. May not be null
      profileName - The name of the profile. May not be null

    • setActiveProfile

      void setActiveProfile(String profileName, boolean isDefaultProfile)
      Sets active profile and stores in the corresponding preferences
      Parameters:
      profileName - The name of the profile. May not be null
      isDefaultProfile - The default profile set, with preferences clearance

    • isMassiveCheckProcessDisabled

      boolean isMassiveCheckProcessDisabled()
      Checks if the massive automatic check pre-computation process is disabled
      Returns:
      True if the process is disabled

    • setMassiveCheckProcessDisabled

      void setMassiveCheckProcessDisabled(boolean massiveCheckProcessDisabled)
      Sets/resets massive check mode
      Parameters:
      massiveCheckProcessDisabled - The mode to set