Interface SetupImpexService

All Known Implementing Classes:
DefaultSetupImpexAddOnService, DefaultSetupImpexService, ProductConfigRulesSetupImpexService, ProductConfigRulesSetupImpexServiceTestHelper

public interface SetupImpexService
Service that handles importing impex files.
  • Method Details

    • importImpexFile

      void importImpexFile(String file, boolean errorIfMissing, boolean legacyMode)
      Import impex file. The file is looked up from the classpath. If the file does not exist then an info message is logged. The file should used the ".impex" file extension. Any language specific files are found with the same root file name then they are also imported. Language specific files have the language iso code appended to the file name using an underscore as a separator. For example if the file /path/file.impex is imported and the language specific file /path/file_de.impex exists, then it will also be imported. Only files for languages that exist in the hybris system will be imported.
      Parameters:
      file - the file path to import
      errorIfMissing - flag, set to true to error if the file is not found
      legacyMode - flag, set to true to use legacy impex mode
    • importImpexFile

      void importImpexFile(String file, boolean errorIfMissing)
      Import impex file. The file is looked up from the classpath. If the file does not exist then an info message is logged. The file should used the ".impex" file extension. Any language specific files are found with the same root file name then they are also imported. Language specific files have the language iso code appended to the file name using an underscore as a separator. For example if the file /path/file.impex is imported and the language specific file /path/file_de.impex exists, then it will also be imported. Only files for languages that exist in the hybris system will be imported. By default this method imports the impex data with legacy mode set to false.
      Parameters:
      file - the file path to import
      errorIfMissing - flag, set to true to error if the file is not found
    • importImpexFile

      boolean importImpexFile(String file, Map<String,Object> macroParameters, boolean errorIfMissing, boolean legacyMode)
      Parameters:
      file - the file path to import
      macroParameters - the macro parameters
      errorIfMissing - flag, set to true to error if the file is not found
      legacyMode - flag, set to true to use legacy impex mode
      Returns:
      false for default implementation
    • importImpexFile

      boolean importImpexFile(String file, Map<String,Object> macroParameters, boolean errorIfMissing)
      Parameters:
      file - the file path to import
      macroParameters - the macro parameters
      errorIfMissing - flag, set to true to error if the file is not found
      Returns:
      false for default implementation
    • importImpexFile

      boolean importImpexFile(String file, ImpexMacroParameterData macroParameters, boolean errorIfMissing, boolean legacyMode)
      Parameters:
      file - the file path to import
      macroParameters - the macro parameters
      errorIfMissing - flag, set to true to error if the file is not found
      legacyMode - flag, set to true to use legacy impex mode
      Returns:
      false for default implementation
    • importImpexFile

      boolean importImpexFile(String file, ImpexMacroParameterData macroParameters, boolean errorIfMissing)
      Parameters:
      file - the file path to import
      macroParameters - the macro parameters
      errorIfMissing - flag, set to true to error if the file is not found
      Returns:
      false for default implementation