org.eclipse.rse.services.clientserver
Interface ISystemOperationMonitor

All Known Implementing Classes:

SystemOperationMonitor

public interface ISystemOperationMonitor

An interface to support cancellation of operations on remote systems, where the Eclipse IProgressMonitor is not avaialble.

Since:

org.eclipse.rse.services 3.0

Method Summary

boolean	isCancelled() Returns whether cancelation of current operation has been requested.
boolean	isDone() Notifies that the work is done; that is, either the main task is completed or the user cancelled it.
void	setCancelled(boolean value) Sets the cancel state to the given value.
void	setDone(boolean value) Sets the done state to the given value.

Method Detail

isDone

public boolean isDone()

Notifies that the work is done; that is, either the main task is completed or the user cancelled it. This method may be called more than once (implementations should be prepared to handle this case).

setDone

public void setDone(boolean value)

Sets the done state to the given value.

Parameters:

value - true indicates that this operation has finished false clears this flag

See Also:

isDone()

isCancelled

public boolean isCancelled()

Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

Returns:

true if cancellation has been requested, and false otherwise

See Also:

setCancelled(boolean)

setCancelled

public void setCancelled(boolean value)

Sets the cancel state to the given value.

Parameters:

value - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag

See Also:

isCancelled()