oracle.ide.task

Interface TaskMonitor

All Known Implementing Classes:

DefaultTaskMonitorImpl

Deprecated.

For asynchronous tasks running, use the RequestProcessor executor service. For task tracking purposes, use the Progress API. See usage examples to start working with the new APIs.

@Deprecated
public interface TaskMonitor

NOT COMPLETE This is the interface used by the task implementor to access services offered by the TaskManager during the execution of the task. Currently the only services offered are update and progress reporting.

Method Summary

Modifier and Type	Method and Description
void	fireProgress(ProgressEvent e) Deprecated. call this method to fire a progress update regarding the task.\
void	fireUpdate(UpdateEvent e) Deprecated. call this method to fire a general update regarding the task.
Task	getSource() Deprecated. Retrieve the Task that this TaskMonitor is initialized for.
TaskMonitor	getTaskMonitorForSegment(int lastProgressCount, int maxProgressCount) Deprecated. Creates a new instance of a TaskMonitor object with the maximum progress normalized to the given value that can then be passed on to a child process or method.

Method Detail

fireUpdate

void fireUpdate(UpdateEvent e)

Deprecated.

call this method to fire a general update regarding the task.

Parameters:

e - TaskUpdate an update object containing information about the update

fireProgress

void fireProgress(ProgressEvent e)

Deprecated.

call this method to fire a progress update regarding the task.\

Parameters:

e - TaskProgress the progress object containing details of the task progress.

getTaskMonitorForSegment

TaskMonitor getTaskMonitorForSegment(int lastProgressCount,
                                     int maxProgressCount)

Deprecated.

Creates a new instance of a TaskMonitor object with the maximum progress normalized to the given value that can then be passed on to a child process or method. This allows the parent method to allocate a certain count that becomes the maximum count for the sub-process.

Parameters:

maxProgressCount - int maximum progress count of the child.

lastProgressCount - int last progress count of the parent.

Returns:

TaskMonitor the normalized TaskMonitor for the child sub-process. The sub-process should fire Progress Updates between 0 and 100, which will be normalized to the extent provided for this sub-process.

getSource

Task getSource()

Deprecated.

Retrieve the Task that this TaskMonitor is initialized for.

Returns:

the Task for which this TaskMonitor object was created.