com.smartbear.testleft.testobjects

Interface TestProcess

All Superinterfaces:

ObjectTreeNode, TestObject

All Known Subinterfaces:

WebBrowser, WinRTProcess

public interface TestProcess
extends ObjectTreeNode

The test interface to a process running in the operating system.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the process by sending the WM_CLOSE message to its main window and waits until the process is closed or the specified time limit is reached.
void	close(int waitTimeout) Closes the process by sending the WM_CLOSE message to its main window and waits until the process is closed or the specified time limit is reached.
String	getCommandLine() The command line passed to the process at the moment of the process creation.
int	getCPUUsage() The approximate percentage of time the CPU is currently spending for the process execution.
Version	getFileVersionInfo() Specifies the version information of the executable that started the process.
int	getHandleCount() Returns the number of used handles in the process.
int	getMemUsage() The amount of memory (in kilobytes) the process is currently using.
String	getPath() The path to the executable that started the process.
int	getPriority() Returns the process priority within the operating system.
int	getProcessId() Returns the process identifier.
PlatformType	getProcessType() Specifies the code type of the process (x64 or x86).
int	getSessionId() Specifies the identifier of the session in which the process is running.
int	getThreadCount() Returns the number of active threads in the process.
String	getUserName() The name of the user account that started the process.
int	getVMSize() The amount of virtual memory (in kilobytes) the process is currently using.
void	saveDumpToLog() Generates a process dump and posts it to the log.
void	saveDumpToLog(boolean fullMemory) Generates a process dump and posts it to the log.
void	terminate() Terminates the process.

Methods inherited from interface com.smartbear.testleft.testobjects.ObjectTreeNode

find, find, find, findAll, findAll, getChildren, getParent, tryFind, tryFind, tryFind, waitProperty, waitProperty

Methods inherited from interface com.smartbear.testleft.testobjects.TestObject

callMethod, callMethod, cast, getProperty, setProperty, toString

Method Detail

getPath

String getPath()
        throws InvocationException,
               HttpException

The path to the executable that started the process.

Returns:

The path to the executable that started the process.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getPriority

int getPriority()
         throws InvocationException,
                HttpException

Returns the process priority within the operating system.

Returns:

The process priority within the operating system.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getProcessId

int getProcessId()
          throws InvocationException,
                 HttpException

Returns the process identifier.

Returns:

The process identifier.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getCommandLine

String getCommandLine()
               throws InvocationException,
                      HttpException

The command line passed to the process at the moment of the process creation.

Returns:

The command line passed to the process at the moment of the process creation.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getUserName

String getUserName()
            throws InvocationException,
                   HttpException

The name of the user account that started the process.

Returns:

The name of the user account that started the process.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getThreadCount

int getThreadCount()
            throws InvocationException,
                   HttpException

Returns the number of active threads in the process.

Returns:

The number of active threads in the process.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getSessionId

int getSessionId()
          throws InvocationException,
                 HttpException

Specifies the identifier of the session in which the process is running.

Returns:

The identifier of the session in which the process is running.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getProcessType

PlatformType getProcessType()
                     throws InvocationException,
                            HttpException

Specifies the code type of the process (x64 or x86).

Returns:

The code type of the process (x64 or x86).

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getHandleCount

int getHandleCount()
            throws InvocationException,
                   HttpException

Returns the number of used handles in the process.

Returns:

The number of used handles in the process.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getCPUUsage

int getCPUUsage()
         throws InvocationException,
                HttpException

The approximate percentage of time the CPU is currently spending for the process execution.

Returns:

The approximate percentage of time the CPU is currently spending for the process execution.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getVMSize

int getVMSize()
       throws InvocationException,
              HttpException

The amount of virtual memory (in kilobytes) the process is currently using.

Returns:

The amount of virtual memory (in kilobytes) the process is currently using.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getMemUsage

int getMemUsage()
         throws InvocationException,
                HttpException

The amount of memory (in kilobytes) the process is currently using.

Returns:

The amount of memory (in kilobytes) the process is currently using.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

getFileVersionInfo

Version getFileVersionInfo()
                    throws InvocationException,
                           HttpException

Specifies the version information of the executable that started the process.

Returns:

The version information of the executable that started the process.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

close

void close()
    throws InvocationException,
           HttpException

Closes the process by sending the WM_CLOSE message to its main window and waits until the process is closed or the specified time limit is reached.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

close

void close(int waitTimeout)
    throws InvocationException,
           HttpException

Closes the process by sending the WM_CLOSE message to its main window and waits until the process is closed or the specified time limit is reached.

Parameters:

waitTimeout - A time limit to wait until the process is closed.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

terminate

void terminate()
        throws InvocationException,
               HttpException

Terminates the process.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

saveDumpToLog

void saveDumpToLog()
            throws InvocationException,
                   HttpException

Generates a process dump and posts it to the log.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.

saveDumpToLog

void saveDumpToLog(boolean fullMemory)
            throws InvocationException,
                   HttpException

Generates a process dump and posts it to the log.

Parameters:

fullMemory - Specifies whether write full memory to dump or not.

Throws:

InvocationException - Will be thrown if invocation fails.

HttpException - Will be thrown if there are network problems.