com.ibm.pdp.maf.rpp.pac.inputaid
Interface InputAidDescriptionLine

All Superinterfaces:
Element

public interface InputAidDescriptionLine
extends Element

Describes the contents of the lines which make-up an input-aid


Field Summary
static java.lang.String copyright
           
 
Method Summary
 InputAidCallTypeLineValues getCallTypeLine()
           
 java.lang.String getFixedLabel()
           
 int getLength()
           
 InputAidDescriptionLineTypeValues getLineType()
           
 java.lang.String getSymbolicParameter()
           
 java.lang.String getVariableLabel()
           
 java.lang.String getXrefKey()
           
 

Field Detail

copyright

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

getCallTypeLine

InputAidCallTypeLineValues getCallTypeLine()

Indicates how the line will be taken into account during the generation process.

Returns:

getFixedLabel

java.lang.String getFixedLabel()

This is the fixed part of a input-aid line.

Cannot be modified once the input-aid has been called and used.

Returns:

getLength

int getLength()

This is the length of the variable label.

This length cannot be modified once the input-aid has been called and used.

Returns:

getLineType

InputAidDescriptionLineTypeValues getLineType()

The type of the line indicates :

- a standard line,

- a comment line,

- a symbolic value line used to define a parameter to be used in the variable label.

Returns:

getSymbolicParameter

java.lang.String getSymbolicParameter()

This field contains the parameter of the symbolic value.

This parameter must exists in the list of the symbolic values defined for the input aid.

Returns:

getVariableLabel

java.lang.String getVariableLabel()

This is the variable pat of a input-aid line.

Returns:

getXrefKey

java.lang.String getXrefKey()

This field contains a cross-reference key code.

It gives the possibility of getting a list of the entities calling the input-aid with the contents of the variable label referenced by ths key code.

Returns: