Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.compile
Interface ISystemCompileXMLConstants

All Known Implementing Classes:
SystemCompileCommand, SystemCompileContributor, SystemCompileProfile

public interface ISystemCompileXMLConstants

Constants used in the persistence of the compile commands, into an xml file


Field Summary
static String COMPILECOMMAND_ELEMENT
          The name of the element (tag) containing all the compile command attributes.
static String Copyright
           
static String COPYRIGHT_ELEMENT
          The name of the copyright element (tag) holding the copyright value.
static String COPYRIGHT_TEXT
          The data of the copyright element (tag).
static String CURRENT_ATTRIBUTE
          The name of the attribute holding the current string value.
static String DEFAULT_ATTRIBUTE
          The name of the attribute holding the default string value.
static String FILE_NAME
           
static String ID_ATTRIBUTE
          The name of the attribute holding the id: "id"
static String JOBENV_ATTRIBUTE
          The name of the attribute holding the job environment value.
static String LABEL_ATTRIBUTE
          The name of the attribute holding the compile command label.
static String LABEL_EDITABLE_ATTRIBUTE
          The name of the attribute holding whether the label is editable: "labeleditable"
static String LASTUSED_ATTRIBUTE
          The name of the attribute holding the last-used compile command.
static String MENU_ATTRIBUTE
          The name of the attribute holding the menu option value.
static String MENU_BOTH_VALUE
          Value for the compile command menu attribute for both prompt and no-prompt commands: "Both"
static String MENU_NON_PROMPTABLE_VALUE
          Value for the compile command menu attribute for no-prompt-only commands: "NoPrompt"
static String MENU_NONE_VALUE
          Value for the compile command menu attribute for neither promptable nor non-promptable commands: "None".
static String MENU_PROMPTABLE_VALUE
          Value for the compile command menu attribute for prompt-only commands: "Prompt"
static String NATURE_ATTRIBUTE
          The name of the attribute holding the nature value.
static String NATURE_IBM_VALUE
          Value for the compile command nature attribute for IBM-supplied commands: "IBM defined"
static String NATURE_ISV_VALUE
          Value for the compile command nature attribute for vendor-supplied commands: "ISV defined"
static String NATURE_USER_VALUE
          Value for the compile command nature attribute for user-supplied commands: "User defined"
static String ORDER_ATTRIBUTE
          The name of the attribute holding the relative order the compile command is to appear in any list of compile commands: "order"
static String ROOT_ELEMENT
          The name of the root element (tag) for the compile types xml file.
static String STRING_EDITABLE_ATTRIBUTE
          The name of the attribute holding whether the command string is editable: "stringeditable"
static String TYPE_ATTRIBUTE
           
static String TYPE_ELEMENT
          The name of the element (tag) containing all the compile command sub-elements (tags) for a source type.
static String VERSION_ATTRIBUTE
          The name of the attribute holding the version number when this document was last written.
static String VERSION_VALUE
          Current version number for the compile framework
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values

FILE_NAME

public static final String FILE_NAME
See Also:
Constant Field Values

ROOT_ELEMENT

public static final String ROOT_ELEMENT
The name of the root element (tag) for the compile types xml file. That element is named "types".

See Also:
Constant Field Values

VERSION_ATTRIBUTE

public static final String VERSION_ATTRIBUTE
The name of the attribute holding the version number when this document was last written. The xml attribute is named "version".

See Also:
Constant Field Values

VERSION_VALUE

public static final String VERSION_VALUE
Current version number for the compile framework

See Also:
Constant Field Values

COPYRIGHT_ELEMENT

public static final String COPYRIGHT_ELEMENT
The name of the copyright element (tag) holding the copyright value. That element is named "copyright".

See Also:
Constant Field Values

COPYRIGHT_TEXT

public static final String COPYRIGHT_TEXT
The data of the copyright element (tag).

See Also:
Constant Field Values

TYPE_ELEMENT

public static final String TYPE_ELEMENT
The name of the element (tag) containing all the compile command sub-elements (tags) for a source type.

The xml element is named "compiletype".

See Also:
Constant Field Values

TYPE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE
See Also:
Constant Field Values

LASTUSED_ATTRIBUTE

public static final String LASTUSED_ATTRIBUTE
The name of the attribute holding the last-used compile command. This value identifies that command via its label value.

The xml attribute is named "lastcompilename", for historical reasons (when compile commands were called compile names).

See Also:
Constant Field Values

COMPILECOMMAND_ELEMENT

public static final String COMPILECOMMAND_ELEMENT
The name of the element (tag) containing all the compile command attributes. The xml element is named "compilename", for historical reasons (when compile commands were called compile names).

See Also:
Constant Field Values

LABEL_ATTRIBUTE

public static final String LABEL_ATTRIBUTE
The name of the attribute holding the compile command label. This is the name the user sees for this compile command. The xml attribute is named "name" for historical reasons (when compile commands were called compile names).

See Also:
Constant Field Values

NATURE_ATTRIBUTE

public static final String NATURE_ATTRIBUTE
The name of the attribute holding the nature value. This tells the framework if this is an IBM-supplied or user-supplied compile command. The xml attribute is named "nature".

See Also:
Constant Field Values

NATURE_IBM_VALUE

public static final String NATURE_IBM_VALUE
Value for the compile command nature attribute for IBM-supplied commands: "IBM defined"

See Also:
Constant Field Values

NATURE_USER_VALUE

public static final String NATURE_USER_VALUE
Value for the compile command nature attribute for user-supplied commands: "User defined"

See Also:
Constant Field Values

NATURE_ISV_VALUE

public static final String NATURE_ISV_VALUE
Value for the compile command nature attribute for vendor-supplied commands: "ISV defined"

See Also:
Constant Field Values

DEFAULT_ATTRIBUTE

public static final String DEFAULT_ATTRIBUTE
The name of the attribute holding the default string value. This is the IBM-supplied value for support of "Restore Defaults". The xml attribute is named "default".

See Also:
Constant Field Values

CURRENT_ATTRIBUTE

public static final String CURRENT_ATTRIBUTE
The name of the attribute holding the current string value. This is the potentially user-edited compile command including parameters. The xml attribute is named "current".

See Also:
Constant Field Values

MENU_ATTRIBUTE

public static final String MENU_ATTRIBUTE
The name of the attribute holding the menu option value. This tells the compile framework if this user action is to displayed in the non-promptable cascading menu, the promptable cascading menu, or both cascading menus. These menus shown in the popup menu for a compilable remote source object. The xml attribute is named "menu".

See Also:
Constant Field Values

MENU_PROMPTABLE_VALUE

public static final String MENU_PROMPTABLE_VALUE
Value for the compile command menu attribute for prompt-only commands: "Prompt"

See Also:
Constant Field Values

MENU_NON_PROMPTABLE_VALUE

public static final String MENU_NON_PROMPTABLE_VALUE
Value for the compile command menu attribute for no-prompt-only commands: "NoPrompt"

See Also:
Constant Field Values

MENU_BOTH_VALUE

public static final String MENU_BOTH_VALUE
Value for the compile command menu attribute for both prompt and no-prompt commands: "Both"

See Also:
Constant Field Values

MENU_NONE_VALUE

public static final String MENU_NONE_VALUE
Value for the compile command menu attribute for neither promptable nor non-promptable commands: "None". These compile commands do not appear in the menu.

See Also:
Constant Field Values

ORDER_ATTRIBUTE

public static final String ORDER_ATTRIBUTE
The name of the attribute holding the relative order the compile command is to appear in any list of compile commands: "order"

See Also:
Constant Field Values

JOBENV_ATTRIBUTE

public static final String JOBENV_ATTRIBUTE
The name of the attribute holding the job environment value. This is not used in all cases, but those that need it (such as for iSeries IFS which needs to prompt for QSYS vs QSHELL cmd), this is where to store it. The attribute name is "jobenv".

See Also:
Constant Field Values

ID_ATTRIBUTE

public static final String ID_ATTRIBUTE
The name of the attribute holding the id: "id"

See Also:
Constant Field Values

LABEL_EDITABLE_ATTRIBUTE

public static final String LABEL_EDITABLE_ATTRIBUTE
The name of the attribute holding whether the label is editable: "labeleditable"

See Also:
Constant Field Values

STRING_EDITABLE_ATTRIBUTE

public static final String STRING_EDITABLE_ATTRIBUTE
The name of the attribute holding whether the command string is editable: "stringeditable"

See Also:
Constant Field Values

Remote Systems
v6.4.1

Copyright © 2005 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.