Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.server.progress
Interface Progress

All Known Implementing Classes:
ProgressImpl, ProgressMonitor

public interface Progress

Progress information on a job/task.

Author:
Simon Templer

Method Summary
 void cancel()
          Cancel the job/task.
 String getSubTask()
           
 String getTaskName()
           
 int getTotalWork()
           
 int getWorked()
           
 boolean isCanceled()
           
 boolean isIndeterminate()
           
 

Method Detail

getTaskName

String getTaskName()
Returns:
the task name, may be null

getSubTask

String getSubTask()
Returns:
the name of the current subtask, may be null

isIndeterminate

boolean isIndeterminate()
Returns:
if the progress is indeterminate

getWorked

int getWorked()
Returns:
the already worked work units, should be ignored if isIndeterminate() is true

getTotalWork

int getTotalWork()
Returns:
the total work units, should be ignored if isIndeterminate() is true

isCanceled

boolean isCanceled()
Returns:
if the job/task is canceled

cancel

void cancel()
Cancel the job/task. Behavior on cancel depends on the implementation of job/task.


Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d