Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.services.qsys.commands
Class QSYSBatchCommandMonitor

java.lang.Object
  extended by com.ibm.etools.iseries.services.qsys.commands.QSYSBatchCommandMonitor
All Implemented Interfaces:
IQSYSBatchCommandMonitor

public class QSYSBatchCommandMonitor
extends Object
implements IQSYSBatchCommandMonitor

A monitor to support cancellation of operations in an environment where Eclipse IProgressMonitor is not available.

Since:
3.0

Constructor Summary
QSYSBatchCommandMonitor()
           
 
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)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QSYSBatchCommandMonitor

public QSYSBatchCommandMonitor()
Method Detail

isDone

public boolean isDone()
Description copied from interface: IQSYSBatchCommandMonitor
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).

Specified by:
isDone in interface IQSYSBatchCommandMonitor

setDone

public void setDone(boolean value)
Description copied from interface: IQSYSBatchCommandMonitor
Sets the done state to the given value.

Specified by:
setDone in interface IQSYSBatchCommandMonitor
Parameters:
value - true indicates that this operation has finished false clears this flag
See Also:
IQSYSBatchCommandMonitor.isDone()

isCancelled

public boolean isCancelled()
Description copied from interface: IQSYSBatchCommandMonitor
Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

Specified by:
isCancelled in interface IQSYSBatchCommandMonitor
Returns:
true if cancellation has been requested, and false otherwise
See Also:
IQSYSBatchCommandMonitor.setCancelled(boolean)

getCommandName

public String getCommandName()
Specified by:
getCommandName in interface IQSYSBatchCommandMonitor

setCommandName

public void setCommandName(String commandName)
Specified by:
setCommandName in interface IQSYSBatchCommandMonitor

setCancelled

public void setCancelled(boolean value)
Description copied from interface: IQSYSBatchCommandMonitor
Sets the cancel state to the given value.

Specified by:
setCancelled in interface IQSYSBatchCommandMonitor
Parameters:
value - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag
See Also:
IQSYSBatchCommandMonitor.isCancelled()

getMessages

public Vector<Object> getMessages()
Specified by:
getMessages in interface IQSYSBatchCommandMonitor

setMessages

public void setMessages(Vector<Object> messages)
Specified by:
setMessages in interface IQSYSBatchCommandMonitor

getJobInfo

public String getJobInfo()
Specified by:
getJobInfo in interface IQSYSBatchCommandMonitor

setJobInfo

public void setJobInfo(String jobInfo)
Specified by:
setJobInfo in interface IQSYSBatchCommandMonitor

getEventFileName

public String getEventFileName()
Specified by:
getEventFileName in interface IQSYSBatchCommandMonitor

setEventFileName

public void setEventFileName(String eventFileName)
Specified by:
setEventFileName in interface IQSYSBatchCommandMonitor

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.