com.tplan.robot.scheduler

Class Task

java.lang.Object

com.tplan.robot.scheduler.AbstractScheduleElement

com.tplan.robot.scheduler.Task

All Implemented Interfaces:

GenericListener<PropertyChangeListener>, Serializable

public class Task
extends AbstractScheduleElement
implements Serializable

Task class encapsulates call of a single test script in a schedule.

See Also:

Serialized Form

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

Constructor Summary

Constructors

Constructor and Description
Task(TestSuite owner)

Method Summary

Modifier and Type	Method and Description
List<String>	getArguments() Get the list of CLI arguments to be passed to the script prior to its execution.
String	getDisplayName() Get the task display name.
com.tplan.robot.scheduler.Task.ExecutionType	getExecutionType()
String	getFullScriptPath() Get the full script path.
AbstractScriptResult	getLastResult()
String	getName() Get the task name.
TestSuite	getOwner() Get the task owner.
String	getScript() Get the test script this task is associated with.
int	getUID() Get the task UID.
void	setExecutionType(com.tplan.robot.scheduler.Task.ExecutionType type)
void	setLastResult(AbstractScriptResult lastResult)
void	setName(String name)
void	setScript(String script)
String	toString() Overridden method returning the task display name as it is returned by getDisplayName().

Methods inherited from class com.tplan.robot.scheduler.AbstractScheduleElement

genericEvent, setChanged

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Task

public Task(TestSuite owner)

Method Detail

getOwner

public TestSuite getOwner()

Get the task owner.

Returns:

test suite owning the task.

getName

public String getName()

Get the task name.

Returns:

the task name.

getDisplayName

public String getDisplayName()

Get the task display name. The method returns the task name returned by getName() or the task file name if the name is not available (is null or empty string).

Returns:

task display name.

setName

public void setName(String name)

getExecutionType

public com.tplan.robot.scheduler.Task.ExecutionType getExecutionType()

setExecutionType

public void setExecutionType(com.tplan.robot.scheduler.Task.ExecutionType type)

getScript

public String getScript()

Get the test script this task is associated with. It may be relative or absolute path. To get the full path use getFullScriptPath().

Returns:

the script.

setScript

public void setScript(String script)

getArguments

public List<String> getArguments()

Get the list of CLI arguments to be passed to the script prior to its execution. See T-Plan Robot Enterprise CLI Options for details.

Returns:

the list of task's CLI arguments.

getUID

public int getUID()

Get the task UID.

Returns:

the task UID.

toString

public String toString()

Overridden method returning the task display name as it is returned by getDisplayName().

Overrides:

toString in class Object

Returns:

the task display name.

getFullScriptPath

public String getFullScriptPath()

Get the full script path. The script returned by getScript() is internally stored in form of a relative path to the schedule XML file. This applies only to scripts which are part of the same project as the schedule. This method converts the relative path to a full one.

Returns:

full (absolute) path of the test script file.

getLastResult

public AbstractScriptResult getLastResult()

Returns:

the lastResult

setLastResult

public void setLastResult(AbstractScriptResult lastResult)

Parameters:

lastResult - the lastResult to set