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

Interface IExportConfigurationFilesApi

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

    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 exportProject​(String projectName, Path configurationFilesLocation)
      Exports the provided V8 project to 1C:Enterprise platform configuration XML files.
      void exportProject​(Path projectLocation, Path configurationFilesLocation)
      Exports the provided V8 project to 1C:Enterprise platform configuration XML files.

    • Method Detail

      • exportProject

        void exportProject​(Path projectLocation,
                   Path configurationFilesLocation)
            throws CliApiException
        Exports the provided V8 project to 1C:Enterprise platform configuration XML files. Allows to exports already existing in workspace project or an external for workspace project.

        Provided project location must contain project in 1C:Enterprise Development Tools format.

        Parameters:
        projectLocation - the location of project in 1C:Enterprise Development Tools format, cannot be null
        configurationFilesLocation - the target folder for 1C:Enterprise platform configuration XML files, cannot be null
        Throws:
        CliApiException - on failure. Reasons include:
        • Provided location does not contain project in 1C:Enterprise Development Tools format
        • Provided project is not imported to workspace but has name of already existing workspace project
        • Internal 1C:Enterprise Development Tools execution error occurred

      • exportProject

        void exportProject​(String projectName,
                   Path configurationFilesLocation)
            throws CliApiException
        Exports the provided V8 project to 1C:Enterprise platform configuration XML files. Allows to exports already existing in workspace project only.

        Project with the provided name must exist in the workspace.

        Parameters:
        projectName - the name of project in 1C:Enterprise Development Tools format in the current workspace, cannot be null
        configurationFilesLocation - the target folder for 1C:Enterprise platform configuration XML files, cannot be null
        Throws:
        CliApiException - on failure. Reasons include:
        • Project with the provided name does not exist in the workspace
        • Internal 1C:Enterprise Development Tools execution error occurred