Interface ComTestManagement

  • All Known Implementing Classes:
    TestManagement

    public interface ComTestManagement
    Represents the ecu.test specific COMTestManagement API.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean exportPackage​(String filePath, String exportPath, boolean createNewPath, int timeout)
      Exports the given package to test management system.
      boolean exportPackageAttributes​(String filePath, int timeout)
      Exports the attributes of given package to test management system.
      boolean exportProject​(String filePath, String exportPath, boolean createNewPath, int timeout)
      Exports the given project to test management system.
      boolean exportProjectAttributes​(String filePath, int timeout)
      Exports the attributes of given project to test management system.
      boolean exportReport​(String filePath, String archivePath, int timeout)
      Exports the given project report file to test management system.
      boolean importPackage​(String tmPackagePath, String importPath, int timeout)
      Imports a package from a test management system.
      boolean importPackageAttributes​(String filePath, int timeout)
      Imports the attributes of given package to test management system.
      boolean importPackageDirectory​(String tmDirectoryPath, String importPath, int timeout)
      Imports a directory from a test management system with all sub directories and package.
      boolean importProject​(String tmProjectPath, String importPath, boolean importMissingPackages, int timeout)
      Imports a project from a test management system.
      boolean importProjectAttributes​(String filePath, int timeout)
      Imports the attributes of given project to test management system.
      boolean importProjectById​(String tmProjectId, String importPath, boolean importMissingPackages, int timeout)
      Imports a project from a test management system.
      boolean importProjectDirectory​(String tmDirectoryPath, String importPath, int timeout)
      Imports a directory from a test management system with all sub directories and projects.
      boolean isAvailable()
      Checks if the test management service can be started.
      boolean login​(String user, String password)
      Performs a login to the preconfigured test management service.
      boolean logout()
      Performs a logout to the preconfigured test management service.
    • Method Detail

      • isAvailable

        boolean isAvailable()
                     throws ETComException
        Checks if the test management service can be started.
        Returns:
        true if the service could be started, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • login

        boolean login​(String user,
                      String password)
               throws ETComException
        Performs a login to the preconfigured test management service.
        Parameters:
        user - the user name
        password - the password
        Returns:
        true if login succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • logout

        boolean logout()
                throws ETComException
        Performs a logout to the preconfigured test management service.
        Returns:
        true if logout succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • importPackage

        boolean importPackage​(String tmPackagePath,
                              String importPath,
                              int timeout)
                       throws ETComException
        Imports a package from a test management system. The tmProjectPath specifies the package in the test management system. The package will be imported into directory given by importPath.
        Parameters:
        tmPackagePath - the path specifying the package in the test management system
        importPath - the directory to save the package (relative to package directory or absolute)
        timeout - the timeout in seconds to wait for import to be finished
        Returns:
        true if import succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • importPackageDirectory

        boolean importPackageDirectory​(String tmDirectoryPath,
                                       String importPath,
                                       int timeout)
                                throws ETComException
        Imports a directory from a test management system with all sub directories and package. The tmDirectoryPath specifies the directory in the test management system. The directory will be imported into the directory given by importPath.
        Parameters:
        tmDirectoryPath - the path specifying the package in the test management system
        importPath - the directory to save the package (relative to package directory or absolute)
        timeout - the timeout in seconds to wait for import to be finished
        Returns:
        true if import succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • importProject

        boolean importProject​(String tmProjectPath,
                              String importPath,
                              boolean importMissingPackages,
                              int timeout)
                       throws ETComException
        Imports a project from a test management system. The tmProjectPath specifies the project in the test management system. The project will be imported into directory given by importPath.
        Parameters:
        tmProjectPath - the path specifying the project in the test management system
        importPath - the directory to save the project (relative to package directory or absolute)
        importMissingPackages - specifies whether missing packages will be automatically imported
        timeout - the timeout in seconds to wait for import to be finished
        Returns:
        true if import succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • importProjectById

        boolean importProjectById​(String tmProjectId,
                                  String importPath,
                                  boolean importMissingPackages,
                                  int timeout)
                           throws ETComException
        Imports a project from a test management system. The tmProjectId specifies the project in the test management system via its ID. The project will be imported into directory given by importPath.
        Parameters:
        tmProjectId - the project ID in test management system
        importPath - the directory to save the project (relative to package directory or absolute)
        importMissingPackages - specifies whether missing packages will be automatically imported
        timeout - the timeout in seconds to wait for import to be finished
        Returns:
        true if import succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • importProjectDirectory

        boolean importProjectDirectory​(String tmDirectoryPath,
                                       String importPath,
                                       int timeout)
                                throws ETComException
        Imports a directory from a test management system with all sub directories and projects. The tmDirectoryPath specifies the directory in the test management system. The directory will be imported into the directory given by importPath.
        Parameters:
        tmDirectoryPath - the path specifying the project in the test management system
        importPath - the directory to save the project (relative to package directory or absolute)
        timeout - the timeout in seconds to wait for import to be finished
        Returns:
        true if import succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • importPackageAttributes

        boolean importPackageAttributes​(String filePath,
                                        int timeout)
                                 throws ETComException
        Imports the attributes of given package to test management system.
        Parameters:
        filePath - the file path of the package whose attributes have to be imported (relative to package directory or absolute)
        timeout - the timeout in seconds to wait for export to be finished
        Returns:
        true if import succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • importProjectAttributes

        boolean importProjectAttributes​(String filePath,
                                        int timeout)
                                 throws ETComException
        Imports the attributes of given project to test management system.
        Parameters:
        filePath - the file path of the project whose attributes have to be imported (relative to package directory or absolute)
        timeout - the timeout in seconds to wait for export to be finished
        Returns:
        true if import succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • exportPackage

        boolean exportPackage​(String filePath,
                              String exportPath,
                              boolean createNewPath,
                              int timeout)
                       throws ETComException
        Exports the given package to test management system. The exportPath is needed to specify where the package should be placed at.
        Parameters:
        filePath - the file path of the package to be exported (relative to package directory or absolute)
        exportPath - the path specifying where the package should be placed at
        createNewPath - if the exportPath does not exist, it will be created
        timeout - the timeout in seconds to wait for export to be finished
        Returns:
        true if export succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • exportProject

        boolean exportProject​(String filePath,
                              String exportPath,
                              boolean createNewPath,
                              int timeout)
                       throws ETComException
        Exports the given project to test management system. The exportPath is needed to specify where the project should be placed at.
        Parameters:
        filePath - the file path of the project to be exported (relative to package directory or absolute)
        exportPath - the path specifying where the project should be placed at
        createNewPath - if the exportPath does not exist, it will be created
        timeout - the timeout in seconds to wait for export to be finished
        Returns:
        true if export succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • exportPackageAttributes

        boolean exportPackageAttributes​(String filePath,
                                        int timeout)
                                 throws ETComException
        Exports the attributes of given package to test management system.
        Parameters:
        filePath - the file path of the package whose attributes have to be exported (relative to package directory or absolute)
        timeout - the timeout in seconds to wait for export to be finished
        Returns:
        true if export succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • exportProjectAttributes

        boolean exportProjectAttributes​(String filePath,
                                        int timeout)
                                 throws ETComException
        Exports the attributes of given project to test management system.
        Parameters:
        filePath - the file path of the project whose attributes have to be exported (relative to package directory or absolute)
        timeout - the timeout in seconds to wait for export to be finished
        Returns:
        true if export succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception
      • exportReport

        boolean exportReport​(String filePath,
                             String archivePath,
                             int timeout)
                      throws ETComException
        Exports the given project report file to test management system. The archive path may be used to copy the report to another directory and to reference it from the test management entry.
        Parameters:
        filePath - the file path of the project report file to be exported
        archivePath - if the exportPath does not exist, it will be created
        timeout - the timeout in seconds to wait for export to be finished
        Returns:
        true if export succeeded, false otherwise
        Throws:
        ETComException - in case of a COM exception