Package de.tracetronic.jenkins.plugins.ecutest.wrapper.com.api

Interface ComPackage

All Known Implementing Classes:

Package

public interface ComPackage

Represents the ecu.test specific COMPackage API.

Method Summary

Modifier and Type	Method	Description
List<AbstractTestClient.CheckInfoHolder>	check()	Returns a list of the errors of the package (including all sub packages).
String	checkNG()	Returns converted error descriptions into specific Warnings NG plugin JSON format.
String	getDescription()	Queries the package description.
String	getName()	Queries the package name.

Method Details

getName

String getName()
        throws ETComException

Queries the package name.

Returns:

the name of this package

Throws:

ETComException - in case of a COM exception

getDescription

String getDescription()
               throws ETComException

Queries the package description.

Returns:

the description of this package

Throws:

ETComException - in case of a COM exception

check

List<AbstractTestClient.CheckInfoHolder> check()
                                        throws ETComException

Returns a list of the errors of the package (including all sub packages).

Every list element is a tuple containing:

• file path
• seriousness (Error, Warning, Note)
• error message
• line number

Returns:

the error list

Throws:

ETComException - in case of a COM exception

checkNG

String checkNG()
        throws ETComException

Returns converted error descriptions into specific Warnings NG plugin JSON format.

• issues
  • fileName (Package name from file path)
  • severity (Error -> ERROR, Warning -> HIGH, Note -> NORMAL)
  • description (error message)
  • startLine (line number)
• size (count of issues)

Returns:

the error descriptions as issues in JSON format

Throws:

ETComException - in case of a COM exception