Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.subsystems.qsys.commands
Class QSYSEventFileInformation

java.lang.Object
  extended by com.ibm.etools.iseries.subsystems.qsys.commands.QSYSEventFileInformation

public class QSYSEventFileInformation
extends Object

This class encapsulates event file information when an event-file-generating command is submitted to run. Prior to running, we update the LDA with the event file information, and we store in this object the LDA information that we need after the command is run, to read the updated LDA.

Instances of this class are used by the command subsystem when it submits commands it detects to be event-file generating.


Field Summary
static String Copyright
           
 
Constructor Summary
QSYSEventFileInformation(QSYSCommandSubSystem subsystem, String commandString)
          Constructor for batch, when we don't have the event file name yet
QSYSEventFileInformation(QSYSCommandSubSystem subsystem, String commandString, String eventFileMbrName)
          Constructor for non-batch, when we have parse the event file mbr name from the command string
 
Method Summary
 String getEventFileLibraryName()
          Call this after successfully reading the LDA.
 String getEventFileMemberName()
          Call this after successfully reading the LDA.
 String getEventFileName()
          Call this after successfully reading the LDA.
 String getEventsFileName()
          Gets the events file name in the form lib/EVFEVENT(mbr).
 IHost getHost()
           
protected  IRunnableContext getRunnableContext(Shell shell)
          Get an IRunnable context to show progress in.
 boolean readLDA()
          Read from the LDA.
 void setEventFile(String evfName)
          Set the event file information.
 void writeLDA(String compileString, String memberName)
          Write necessary information into the LDA, and store returned information in this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

QSYSEventFileInformation

public QSYSEventFileInformation(QSYSCommandSubSystem subsystem,
                                String commandString,
                                String eventFileMbrName)
Constructor for non-batch, when we have parse the event file mbr name from the command string

Parameters:
subsystem - the command subsystem.
commandString - the command string.
eventFileMbrName - the event file member name. Must be uppercase (don't uppercase letters within quotes).

QSYSEventFileInformation

public QSYSEventFileInformation(QSYSCommandSubSystem subsystem,
                                String commandString)
Constructor for batch, when we don't have the event file name yet

Method Detail

writeLDA

public void writeLDA(String compileString,
                     String memberName)
              throws SystemMessageException
Write necessary information into the LDA, and store returned information in this object.

Throws:
SystemMessageException

readLDA

public boolean readLDA()
                throws SystemMessageException
Read from the LDA. If this returns true, then call showEventsFileInErrorListView. This is only called for non-batch submissions.

Returns:
false if the compiler did not respond to the key in the LDA or if an exception occurred, true otherwise
Throws:
SystemMessgeException - if there are errors trying to read the LDA
SystemMessageException

getEventFileLibraryName

public String getEventFileLibraryName()
Call this after successfully reading the LDA. It returns the library name of the event file


getEventFileName

public String getEventFileName()
Call this after successfully reading the LDA. It returns the file name of the event file. This is always "EVFEVENT"


getEventFileMemberName

public String getEventFileMemberName()
Call this after successfully reading the LDA. It returns the member name of the event file.


getEventsFileName

public String getEventsFileName()
Gets the events file name in the form lib/EVFEVENT(mbr).

Returns:
the event file name, or null if the events file name is not known.

setEventFile

public void setEventFile(String evfName)
Set the event file information. Called after a batch submission

Parameters:
evfName - - fully qualified eventfile name: lib/file(mbr)

getRunnableContext

protected IRunnableContext getRunnableContext(Shell shell)
Get an IRunnable context to show progress in. If there is currently a dialog or wizard up with a progress monitor in it, we will use this, else we will create a progress monitor dialog.


getHost

public IHost getHost()

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.