com.plumtree.uiinfrastructure.diagnostic.testinterface
Interface IProgressTracker

All Known Implementing Classes:

IndividualTestProgressTracker

public interface IProgressTracker

Used to track the progress of a single task. An array of these objects can form reports of total startup.

Author:

DavidP

Method Summary

void	complete() Called by testrunner when test completes
void	decrement() Called by testrunner when a test step fails and has to be backtracked
boolean	getCompleted() Returns true if the overall task completed, no matter what the status
int	getCompletedSteps() Gets the number of steps completed
int	getCurTask() Returns number of tasks to be run
int	getNumSteps() Returns maximum value of progress indicator for this test
int	getNumTasks() Returns number of tasks to be run
ReturnValue	getRetval(int step) Gets a specific return value for a step.
void	increment() Called by testrunner for each test step
void	init(int iTask, int iNumTasks, boolean verbose) Sets the number of tasks to be run
void	notifyevent(int iStep, ReturnValue retval) Called by testrunner to add a message to the message log
void	notifyevent(java.lang.String message, boolean verbose) Called by testrunner to add a message to the message log
void	setCompleted(boolean bCompleted) sets the completed boolean
void	setName(java.lang.String name) Tracks th ename of this task.
void	setNumSteps(int max) Sets the maximum for progress tracking
void	setRetval(int step, ReturnValue retval) Sets a specific return value for a step.

Method Detail

init

void init(int iTask,
          int iNumTasks,
          boolean verbose)

Sets the number of tasks to be run

setName

void setName(java.lang.String name)

Tracks th ename of this task.

Parameters:

name -

getNumTasks

int getNumTasks()

Returns number of tasks to be run

Returns:

getCurTask

int getCurTask()

Returns number of tasks to be run

Returns:

getNumSteps

int getNumSteps()

Returns maximum value of progress indicator for this test

Returns:

getRetval

ReturnValue getRetval(int step)

Gets a specific return value for a step. Step 0 is init.

Parameters:

min -

setRetval

void setRetval(int step,
               ReturnValue retval)

Sets a specific return value for a step. Step 0 is init.

Parameters:

min -

setNumSteps

void setNumSteps(int max)

Sets the maximum for progress tracking

Parameters:

min -

increment

void increment()

Called by testrunner for each test step

decrement

void decrement()

Called by testrunner when a test step fails and has to be backtracked

complete

void complete()

Called by testrunner when test completes

notifyevent

void notifyevent(java.lang.String message,
                 boolean verbose)

Called by testrunner to add a message to the message log

Parameters:

message -

notifyevent

void notifyevent(int iStep,
                 ReturnValue retval)

Called by testrunner to add a message to the message log

Parameters:

message -

getCompleted

boolean getCompleted()

Returns true if the overall task completed, no matter what the status

setCompleted

void setCompleted(boolean bCompleted)

sets the completed boolean

getCompletedSteps

int getCompletedSteps()

Gets the number of steps completed