Package com._1c.g5.v8.dt.cli.api.workspace

Interface IImportConfigurationFilesApi

  • public interface IImportConfigurationFilesApi
    API to import 1C:Enterprise platform configuration XML files to V8 projects.

    This interface is a public 1C:Enterprise Development Tools contract to call from Cli.

    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void importProject​(Path configurationFilesLocation, String projectName, String version, String baseProjectName)
      Imports 1C:Enterprise platform configuration XML files as a new V8 project with the provided platform version.
      void importProject​(Path configurationFilesLocation, Path projectLocation, String version, String baseProjectName)
      Imports 1C:Enterprise platform configuration XML files as a new V8 project with the provided platform version.

    • Method Detail

      • importProject

        void importProject​(Path configurationFilesLocation,
                   Path projectLocation,
                   String version,
                   String baseProjectName)
            throws CliApiException
        Imports 1C:Enterprise platform configuration XML files as a new V8 project with the provided platform version. If platform version not provided then it will be resolved by platform configuration XML files version.
        Parameters:
        configurationFilesLocation - the source folder for 1C:Enterprise platform configuration XML files to import, cannot be null
        projectLocation - the location of project in 1C:Enterprise Development Tools format, cannot be null
        version - the 1C:Enterprise platform verrsion, e.g. 8.3.11, or null to resolve version by provided platform configuration XML files version
        baseProjectName - the name of the base project or null if none
        Throws:
        CliApiException - on failure. Reasons include:
        • Provided location does not contain platform configuration XML files
        • There is existing workspace project with the same name
        • Base project name is provided but target project is not of dependent project type
        • Internal 1C:Enterprise Development Tools execution error occurred

      • importProject

        void importProject​(Path configurationFilesLocation,
                   String projectName,
                   String version,
                   String baseProjectName)
            throws CliApiException
        Imports 1C:Enterprise platform configuration XML files as a new V8 project with the provided platform version. If platform version not provided then it will be resolved by platform configuration XML files version.
        Parameters:
        configurationFilesLocation - the source folder for 1C:Enterprise platform configuration XML files to import, cannot be null
        projectName - the name of project in 1C:Enterprise Development Tools format in the current workspace, cannot be null
        version - the 1C:Enterprise platform verrsion, e.g. 8.3.11, or null to resolve version by provided platform configuration XML files version
        baseProjectName - the name of the base project or null if none
        Throws:
        CliApiException - on failure. Reasons include:
        • Provided location does not contain platform configuration XML files
        • There is existing workspace project with the same name
        • Base project name is provided but target project is not of dependent project type
        • Internal 1C:Enterprise Development Tools execution error occurred