com.tplan.robot.scripting

Interface ScriptedExecutable

All Known Subinterfaces:

RepeatingScriptedExecutable, TestScriptInterpret

All Known Implementing Classes:

AbstractTestScriptInterpret, PlainTextInterpret, Schedule

public interface ScriptedExecutable

Interface declaring basic status methods of a scripted executable object (test script, test suite, schedule, ...).

Since:

4.0

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

Method Summary

Modifier and Type	Method and Description
boolean	isExecuting() Find out if the executable is currently executing or paused.
boolean	isPause() Find out if the executable is executing and paused.
boolean	isStop() Find out if the executable was stopped.
void	setPause(Object source, boolean pause, String reason) Request to pause the executing object.
void	setStop(Object source, boolean stop, boolean isManual, String manualStopJustification) Request to stop the executing object.

Method Detail

isExecuting

boolean isExecuting()

Find out if the executable is currently executing or paused.

Returns:

true if executing, false if not.

isStop

boolean isStop()

Find out if the executable was stopped.

Returns:

true if the executable was stopped.

setStop

void setStop(Object source,
             boolean stop,
             boolean isManual,
             String manualStopJustification)

Request to stop the executing object.

Parameters:

source - source of the request (for tracking purposes).

stop - true to request stop, false to reset the stop flag.

isManual - true if the stop is manual/user requested (for tracking purposes).

manualStopJustification - optional stop justification.

isPause

boolean isPause()

Find out if the executable is executing and paused.

Returns:

true if the executable is paused.

setPause

void setPause(Object source,
              boolean pause,
              String reason)

Request to pause the executing object.

Parameters:

source - source of the request (for tracking purposes).

pause - true to request pause, false to reset the pause flag.

reason - optional pause justification.