com.ibm.etools.iseries.util
Class IBMIQSYSEventFileInformation

java.lang.Object
  com.ibm.etools.iseries.util.IBMIQSYSEventFileInformation

public class IBMIQSYSEventFileInformation
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.

Field Summary

static String

Copyright

Constructor Summary

IBMIQSYSEventFileInformation(AS400 as400, String commandString)
Constructor to use when we don't have the event file name yet.

IBMIQSYSEventFileInformation(AS400 as400, String commandString, String eventFileMbrName)
Constructor to use when we have parsed the event file mbr name from the command string.

Method Summary

String	getEventFileLibraryName() Returns the library name of the event file.
String	getEventFileMemberName() Returns the member name of the event file.
String	getEventFileName() Returns the file name of the event file.
String	getEventsFileName() Gets the events file name in the form lib/EVFEVENT(mbr).
boolean	readLDA() Read from the LDA.
void	setEventFile(String evfName) Sets the event file information.
void	writeLDA(String compileString, String memberName) Write necessary information into the LDA.

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

IBMIQSYSEventFileInformation

public IBMIQSYSEventFileInformation(AS400 as400,
                                    String commandString,
                                    String eventFileMbrName)

Constructor to use when we have parsed the event file mbr name from the command string.

Parameters:

as400 - the system on which the command will be run.

commandString - the command string.

eventFileMbrName - the event file member name. Must be uppercase (don't uppercase letters within quotes).

See Also:

IBMIQSYSEventFileCommandDetector

IBMIQSYSEventFileInformation

public IBMIQSYSEventFileInformation(AS400 as400,
                                    String commandString)

Constructor to use when we don't have the event file name yet.

Parameters:

as400 - the system on which the command will be run.

commandString - the command string.

See Also:

IBMIQSYSEventFileCommandDetector

Method Detail

writeLDA

public void writeLDA(String compileString,
                     String memberName)
              throws Exception

Write necessary information into the LDA.

Parameters:

compileString - the compile string that will be run.

memberName - the name of the event file member.

Throws:

Exception - if there was a problem writing to the LDA.

See Also:

IBMIQSYSEventFileCommandDetector

readLDA

public boolean readLDA()
                throws Exception

Read from the LDA. If this returns true, the LDA has the location of the events file which is stored in this object. If this returns false, the LDA does not have the location of the events file.

Returns:

false if the compiler did not respond to the key in the LDA or if an exception occurred, true otherwise.

Throws:

Exception - if there was a problem reading from the LDA.

getEventFileLibraryName

public String getEventFileLibraryName()

Returns the library name of the event file. Call this after successfully reading the LDA.

Returns:

the library name of the event file.

getEventFileName

public String getEventFileName()

Returns the file name of the event file. Call this after successfully reading the LDA.

Returns:

the file name of the event file, which is always "EVFEVENT".

getEventFileMemberName

public String getEventFileMemberName()

Returns the member name of the event file. Call this after successfully reading the LDA.

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)
                  throws IllegalArgumentException

Sets the event file information.

Parameters:

evfName - the fully qualified event file name which must be of the form lib/file(mbr).

Throws:

IllegalArgumentException