com.ibm.etools.iseries.services.qsys.commands
Interface IQSYSBatchCommandMonitor

All Known Implementing Classes:

QSYSBatchCommandMonitor

public interface IQSYSBatchCommandMonitor

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

String	getCommandName()
String	getEventFileName()
String	getJobInfo()
Vector<Object>	getMessages()
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	setCommandName(String commandName)
void	setDone(boolean value) Sets the done state to the given value.
void	setEventFileName(String eventFileName)
void	setJobInfo(String jobInfo)
void	setMessages(Vector<Object> messages)

Method Detail

isDone

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

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

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

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()

getMessages

Vector<Object> getMessages()

setMessages

void setMessages(Vector<Object> messages)

getJobInfo

String getJobInfo()

setJobInfo

void setJobInfo(String jobInfo)

getEventFileName

String getEventFileName()

setEventFileName

void setEventFileName(String eventFileName)

getCommandName

String getCommandName()

setCommandName

void setCommandName(String commandName)