com.tplan.robot.scripting.commands.impl
Class TimerInfo

java.lang.Object
  com.tplan.robot.scripting.commands.impl.TimerInfo

All Implemented Interfaces:

OutputObject

public class TimerInfo
extends Object
implements OutputObject

Timer output object for reporting of data created by the Timer command.

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

Field Summary

static int

TYPE_TIMER

Fields inherited from interface com.tplan.robot.scripting.commands.OutputObject

TYPE_ERROR, TYPE_LOG, TYPE_SCREENSHOT, TYPE_STATUS, TYPE_UNKNOWN, TYPE_WARNING

Method Summary

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.
String	getName()
long	getReferenceValue()
long	getTime()
int	getType() Get the output object type.
void	setAttribute(String name, Object value)
void	start()
void	stop()
Map<String,Object>	toMap() Return a map of valid properties of this output object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_TIMER

public static final int TYPE_TIMER

See Also:

Constant Field Values

Method Detail

setAttribute

public void setAttribute(String name,
                         Object value)

getName

public String getName()

getType

public int getType()

Description copied from interface: OutputObject

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.

Specified by:

getType in interface OutputObject

Returns:

output object type.

getCode

public String getCode()

Description copied from interface: OutputObject

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

Specified by:

getCode in interface OutputObject

Returns:

output object code.

start

public void start()

stop

public void stop()

getDescription

public String getDescription()

Description copied from interface: OutputObject

Get the output object description.

Specified by:

getDescription in interface OutputObject

Returns:

output object description.

getDate

public Date getDate()

Description copied from interface: OutputObject

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

Specified by:

getDate in interface OutputObject

Returns:

output object date.

toMap

public Map<String,Object> toMap()

Description copied from interface: OutputObject

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.

Specified by:

toMap in interface OutputObject

Returns:

map of the object properties.

getTime

public long getTime()

Returns:

the time

getReferenceValue

public long getReferenceValue()

Returns:

the referenceValue