net.bluemind.core.task.service

Interface IServerTaskMonitor

All Known Subinterfaces:

ISubTaskMonitorParent

All Known Implementing Classes:

AbstractTaskMonitor, CliTaskMonitor, DelegateTaskMonitor, LoggingTaskMonitor, MaintenanceTaskMonitor, NullTaskMonitor, SchedulerProgressMonitor, SchedulerTaskMonitor, SubTaskMonitor, TaskMonitor, TestMonitor, TestMonitor, TestMonitor, TestMonitor, TestMonitor, TestMonitor, TestMonitor, TestMonitor, TestMonitor

public interface IServerTaskMonitor

Method Summary

Modifier and Type	Method and Description
void	begin(double totalWork, java.lang.String log) Notifies that the task is beginning.
void	end(boolean success, java.lang.String log, java.lang.String result) Notifies that the task has been completed.
void	log(java.lang.String log)
void	progress(double doneWork, java.lang.String log) Notifies that a given number of work unit of the task has been completed.
IServerTaskMonitor	subWork(double work)
IServerTaskMonitor	subWork(java.lang.String logPrefix, double work) Create a sub task monitor that uses a given amount of work unit from the task

Method Detail

subWork

IServerTaskMonitor subWork(double work)

See Also:

subWork(String, double)

subWork

IServerTaskMonitor subWork(java.lang.String logPrefix,
                           double work)

Create a sub task monitor that uses a given amount of work unit from the task

Parameters:

logPrefix -

work - the total number of work units given to the sub task monitor task.

Returns:

a sub task monitor. Begin must be called on the return monitor

begin

void begin(double totalWork,
           java.lang.String log)

Notifies that the task is beginning. This must only be called once on a given monitor instance.

Parameters:

totalWork - the total number of work units into which the task is been subdivided.

progress

void progress(double doneWork,
              java.lang.String log)

Notifies that a given number of work unit of the task has been completed.

Parameters:

doneWork - number of work units just completed

log -

end

void end(boolean success,
         java.lang.String log,
         java.lang.String result)

Notifies that the task has been completed.

Parameters:

success -

log -

result -

log

void log(java.lang.String log)