com.ibm.pdp.maf.rpp.pac.dataelement

Interface DataElementDescription

  • All Superinterfaces:
    Element


    public interface DataElementDescription
    extends Element

    The Data Element Description is used to assign explanatory text to the Data Element, and values or ranges of possible values with their meaning.

    It is also used to complement the description. It provides specific information which will be used where the Data Element is required (screen labels and format, relational database name...).

    Each value or range of values is entered as a code and a label; this label it to be used in user documentation. The values or ranges can be used in the Data Element validation process in batch and online programs.

    • Method Detail

      • getAllowedValues

        java.lang.String getAllowedValues()

        This field is used to specify the authorized values of the Data Element.

        These values undergo automatic validation if they are entered as either numeric or alphanumeric literals (quotation marks for the latter).

        If the Data Element takes on a range of values, the range must be described as two values between parentheses and separated by at least a space. Inverted parentheses indicate that the given value is excluded from the range.

        If the description of a value calls for several lines, the value must be entered on the first line.

        The values assigned to a parent Data Element are automatically assigned to each of its child Data Elements.

        If the Type of line is set to:

        • C, you must enter the delimiter for the end of each column label line (left-aligned). The default value is /.

        • L, you must enter the delimiter for the end of the short label, (left-aligned). The default value is /.

        • O or I, you must enter the value that corresponds to the specific operation or action.

        There are other values for this field.

        They are specific to the OLSD and Pacbench C/S functions :

        • *9 : Numeric Data Element. It generates a COBOL NOT NUMERIC control.

        • * B : Numeric Data Element: Leading blanks are replaced with zeros.

        • *Z : Numeric Data Element: All blanks are replaced with zeros

        • *A : Alphabetic Data Element: controls that all characters are alphabetic.

        • *L : Alphabetic Data Element: controls that all characters are lowercase alphabetic.

        • *U : Alphabetic Data Element: controls that all characters are uppercase alphabetic.

        and to the specifications of a conversational format :

        • I : Without century (picture x(6)): YYMMDD

        • S : With century (picture x(8)): CCYYMMDD

        • D : Without century (picture x(6)): MMDDYY or DDMMYYdepending on the value entered in the Generated date format field on the Library Definition.

        • C : With century (picture x(8)): MMDDCCYY or DDMMCCYYdepending on the value entered in the Generated date format field on the Library Definition.

        • G : With century (picture x(10)): CCYY-MM-DD in a Gregorian format.

        • E : Without century (picture x(8)): MM/DD/YY or DD/MM/YY

        • M : With century (picture x(10)): MM/DD/CCYY or DD/MM/CCYY

        • T : Time

        • TS : Timestamp

        Returns:
      • getDescription

        java.lang.String getDescription()

        The value entered here depends upon the value of the Type of line field.

        • With ' ', D, O, I: Enter a descriptive comment (optional).

        • With L, C, or P: Enter the label (with delimiters as needed) or a presentation value.

        • With A: Enter the Segment code where the parent Data Element is called.

        • With R: Enter the relational column name.

        • With E: Enter the non-standard date format with one or several of the following elements:For more information, see the DBMS documentation.

        • For NONSTOP SQL: input of start field and end field

        • With F (for Data Elements other than dates): Enter the output format (using standard COBOL syntax).

        Returns:
      • getLineType

        DataElementDescriptionLineTypeValues getLineType()

        The line type are classified into several categories :

        • General line types : Blank or D

        • Special line types for the OnLine Systems Development, Pacbench C/S and Pactables functions : P, L, C, F, O and I

        • Special line types for relational databases : R and E

        • Line type specific to Data Elements coming from Reverse Engineering : S

        • Line type for COBOL Copybooks : A

        Returns:
      • getMore

        DataElementDescriptionLineMoreValues getMore()

        The more Lines are used to specify:

        • A line skip or page skip : Blank, *, 0 to 9

        • The continuation of a value range when a value does not fit on a single line : +

        • The action code (if the type of line is set to I) : C, M, D, X

        • The operation code (if the type line is set to O) : A, M, S, E, P, O

        Returns: