com.ibm.pdp.maf.rpp.pac.macro
Interface Macro

All Superinterfaces:
AbstractRadicalElement, Element, RadicalElement

public interface Macro
extends AbstractRadicalElement

The purpose of a Macro is to standardize functions that are common to several programs, or to several procedures of the same program. A called Macro is a complement to the generation possibilities of the system. A Macro is usually displayed in a program description as if its lines had been directly entered by a programmer.

A Macro is not a subprogram because, unlike a subprogram, a Macro can contain non-consecutive statements.

However, a Macro can call a subprogram.

There are six basic types of Macros:


Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.List<CommentsParameters> getComments()
          Document the Macro parameters.
 java.util.List<GLine> getGELines()
          Lists of the user label errors.
 java.lang.String getProgramId()
          COBOL program ID of the Macro.
 
Methods inherited from interface com.ibm.pdp.maf.rpp.pac.common.AbstractRadicalElement
getGCLines
 
Methods inherited from interface com.ibm.pdp.maf.rpp.kernel.RadicalElement
getDescriptionTypes, getKeywords, getLabel, getName, getPackage, getProject
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getComments

java.util.List<CommentsParameters> getComments()

Document the Macro parameters.

It is meant to help developers when calling a Macro in the -CP Lines tab of a Program, a Screen or a Server to know the exact meaning of each parameter.

Returns:

getGELines

java.util.List<GLine> getGELines()

Lists of the user label errors.

Returns:

getProgramId

java.lang.String getProgramId()

COBOL program ID of the Macro.

Returns: