com.tplan.robot.scripting.commands

Interface OutputObject

All Known Implementing Classes:

ScriptLogger

public interface OutputObject

Output object interface. An output object is an object produced by test script execution, such as a screenshot, image comparison result, error message or a log. Each object type is uniquely identified through a type number. If you implement your own output object, do not use numbers between 1 and 100 which are reserved for internal T-Plan Robot objects.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_ERROR Code of an error message.
static int	TYPE_LOG Code of a generic log output object.
static int	TYPE_SCREENSHOT Screenshot output object type numeric code.
static int	TYPE_STATUS Code of an error message.
static int	TYPE_UNKNOWN Unknown output object type numeric code.
static int	TYPE_WARNING Code of a warning message.

Method Summary

Modifier and Type	Method and Description
String	getCode() Get code of the output object.
Date	getDate() Get date and time of when the output object was created.
String	getDescription() Get the output object description.
int	getType() Get the output object type.
Map<String,Object>	toMap() Return a map of valid properties of this output object.

Field Detail

TYPE_UNKNOWN

static final int TYPE_UNKNOWN

Unknown output object type numeric code.

See Also:

Constant Field Values

TYPE_SCREENSHOT

static final int TYPE_SCREENSHOT

Screenshot output object type numeric code.

See Also:

Constant Field Values

TYPE_LOG

static final int TYPE_LOG

Code of a generic log output object.

See Also:

Constant Field Values

TYPE_WARNING

static final int TYPE_WARNING

Code of a warning message.

See Also:

Constant Field Values

TYPE_ERROR

static final int TYPE_ERROR

Code of an error message.

See Also:

Constant Field Values

TYPE_STATUS

static final int TYPE_STATUS

Code of an error message.

See Also:

Constant Field Values

Method Detail

getType

int getType()

Get the output object type. If you implement your own output object, do not use numbers between 1 and 100 which are reserved for internal T-Plan Robot objects.

Returns:

output object type.

getCode

String getCode()

Get code of the output object. It is typically used as a tag in the output XML.

Returns:

output object code.

getDescription

String getDescription()

Get the output object description.

Returns:

output object description.

getDate

Date getDate()

Get date and time of when the output object was created.

Returns:

output object date.

toMap

Map<String,Object> toMap()

Return a map of valid properties of this output object. This is used for generic output without knowing the actual type of the output object and its properties.

Returns:

map of the object properties.