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

Interface IValidateApi

public interface IValidateApi

API to validate V8 projects and save validation results to a file.

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

Modifier and Type	Method	Description
void	validateProjects(Collection<Path> projectLocations, Path file)	Validate a collection of the V8 project and save validation results to a file.
void	validateProjectsByNames(Collection<String> projectNames, Path file)	Validate a collection of the V8 project and save validation results to a file.

Method Detail

validateProjects

void validateProjects(Collection<Path> projectLocations,
                      Path file)
               throws CliApiException

Validate a collection of the V8 project and save validation results to a file. Allows to validate already existing in workspace projects or external for workspace projects.

All provided project locations must contain project in 1C:Enterprise Development Tools format.

Parameters:

projectLocation - a collection of project locations in 1C:Enterprise Development Tools format, cannot be null

file - a file to save validation results in, cannot be null

Throws:

CliApiException - on failure. Reasons include:

• Some of 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

validateProjectsByNames

void validateProjectsByNames(Collection<String> projectNames,
                             Path file)
                      throws CliApiException

Validate a collection of the V8 project and save validation results to a file. Allows to validate already existing in workspace projects only.

All provided project names must exist in the workspace.

Parameters:

projectNames - a collection of project names in 1C:Enterprise Development Tools format in the current workspace, cannot be null

file - a file to save validation results in, cannot be null

Throws:

CliApiException - on failure. Reasons include:

• Some of provided project names does not exist in the workspace
• Internal 1C:Enterprise Development Tools execution error occurred