com.ibm.etools.iseries.rse.ui.compile
Class QSYSCompileCommand

java.lang.Object
  SystemDefaultCompileCommand
      com.ibm.etools.iseries.rse.ui.compile.QSYSCompileCommand

Direct Known Subclasses:

IFSCompileCommand

public class QSYSCompileCommand
extends SystemDefaultCompileCommand

This class encapsulates, for a particular iSeries compile command, the important information for that command including:

• The name, as in CRTRPGMOD
• The default command string with the minimum parameters we need to simply run the command, using substitution variables
• The default command string with the minimum parameters we need to compile with this command, using substitution variables. This includes event file parameters

Field Summary

static String	Copyright
protected String	nameSubstVar

Constructor Summary

QSYSCompileCommand(String commandName)
Constructor for ISeriesIBMCompileCommand when just have a command name.

QSYSCompileCommand(String commandName, boolean supportsSRCMBR, boolean supportsPGMorMODULE, boolean supportsDBGVIEW)
Constructor for ISeriesIBMCompileCommand when have all info.

Method Summary

String	addEVFOption(String compileParams) Given a command without the option to produce an events file, add it to ensure that an events file is produced.
String	fillWithRequiredParams(String commandParams) Given user-specified command paramaters (minus the cmd name), verify it has all the minimum parameters we defined for this command.
String	getCommandWithParameters() Return command fully populated with default parameters and substitution variables
protected String	getNameSubstitutionVariable() Overridable method to return the substitution variable for the selected resource name.
boolean	isSQLCommand() Return true if this is an SQL command
void	setMODULE(boolean isMODULE) Call this to indicate if this command is PGM or MODULE for its target parameter.
void	setNameSubstitutionVariable(String namesv) Set the value to use for the target module or program name, if you don't want to use the default of &N.
void	setOBJ(boolean isOBJ) Call this to indicate if this command should use OBJ vs PGM/MODULE for its target parameter
void	setSupportsEventFile(boolean supportsEventFile) Call this if the command does not support the OPTION(*EVENTF) parameter.
void	setSupportsIFS(boolean supportsIFS) Call this if this is a compile out of the IFS
void	setSupportsReplace(boolean supportsReplace) Call this if the command does not support the REPLACE parameter.
void	setUseCURLIB(boolean useCURLIB) Call this to indicate this command should use *CURLIB for the PGM/MODULE parms versus &O

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

nameSubstVar

protected String nameSubstVar

Constructor Detail

QSYSCompileCommand

public QSYSCompileCommand(String commandName)

Constructor for ISeriesIBMCompileCommand when just have a command name. The label defaults to the command name. You must call setAdditionalCommandParameters after this.

QSYSCompileCommand

public QSYSCompileCommand(String commandName,
                          boolean supportsSRCMBR,
                          boolean supportsPGMorMODULE,
                          boolean supportsDBGVIEW)

Constructor for ISeriesIBMCompileCommand when have all info.

Parameters:

supportsSRCMBR - - true if this command supports the SRCFILE(&L/&F) and SRCMBR(&N) parameters

supportsPGMorMODULE - - true if this command supports the PGM(&O/&N) or MODULE(&O/&N) parameter

supportsDBGVIEW - - true if this command supports DBGVIEW(*SOURCE)

See Also:

setUseCURLIB(boolean), #setAdditionalParameters(String)

Method Detail

setUseCURLIB

public void setUseCURLIB(boolean useCURLIB)

Call this to indicate this command should use *CURLIB for the PGM/MODULE parms versus &O

setMODULE

public void setMODULE(boolean isMODULE)

Call this to indicate if this command is PGM or MODULE for its target parameter.

setOBJ

public void setOBJ(boolean isOBJ)

Call this to indicate if this command should use OBJ vs PGM/MODULE for its target parameter

setSupportsReplace

public void setSupportsReplace(boolean supportsReplace)

Call this if the command does not support the REPLACE parameter. Default is true, it does support it.

setSupportsEventFile

public void setSupportsEventFile(boolean supportsEventFile)

Call this if the command does not support the OPTION(*EVENTF) parameter. Default is true, it does support it.

setSupportsIFS

public void setSupportsIFS(boolean supportsIFS)

Call this if this is a compile out of the IFS

getCommandWithParameters

public String getCommandWithParameters()

Return command fully populated with default parameters and substitution variables

fillWithRequiredParams

public String fillWithRequiredParams(String commandParams)

Given user-specified command paramaters (minus the cmd name), verify it has all the minimum parameters we defined for this command. For any that are missing, add them...

addEVFOption

public String addEVFOption(String compileParams)

Given a command without the option to produce an events file, add it to ensure that an events file is produced.

isSQLCommand

public boolean isSQLCommand()

Return true if this is an SQL command

setNameSubstitutionVariable

public void setNameSubstitutionVariable(String namesv)

Set the value to use for the target module or program name, if you don't want to use the default of &N.

getNameSubstitutionVariable

protected String getNameSubstitutionVariable()

Overridable method to return the substitution variable for the selected resource name. Returns "&N" by default, or an explicit value if set via setNameSubstitutionVariable().