com.ibm.pdp.maf.rpp.pac.report

Interface EditionLine

  • All Superinterfaces:
    Element


    public interface EditionLine
    extends Element

    A edition line in a category of the layout shows the type of jump, the number of lines to skip, or the absolute line number, the function to be performed before printing, the type of lines with fields to accumulate in a Report total, and the totaling structure Report field.

    • Method Detail

      • getComment

        java.lang.String getComment()
        Returns:
      • getForeignTotalStructure

        java.lang.String getForeignTotalStructure()

        Structure number on a line whose fields are to be totalled or on a total line whose detail line is described in a another Report. Some detail lines may be defined in a different Report: for example, a summary Report based on accumulations from other Reports. Only the totalled Data Elements will be printed, at the appropriate control break level.

        Returns:
      • getFunctionToPerform

        java.lang.String getFunctionToPerform()

        Code of the function and subfunction which must be performed before the structure number indicated on this line is processed, and before the WRITE command. The code is four characters long.

        The same structure number may be used in several categories. In this case the PERFORM will take place each time through the processing loop for that structure. It is not necessary to enter the function or subfunction code on the first category that uses that structure.

        A function should not be indicated more than once for the same structure. In cases where several functions are to be performed with the same structure, the execution sequence may be problematic.

        For the lines without a specified structure number, the function will be performed only once, before the structures processing is completed, and just before the WRITE command. This function is performed according to the positioning of the associated structure and thus to the type or condition of the category in which the structure is called.

        Returns:
      • getJump

        int getJump()

        This field indicates the number of lines to skip if the line is not the first line in the category.

        Returns:
      • getJumpType

        ReportEditionLineJumpTypeValues getJumpType()

        Type of skip to be inserted before generation. The default option is 'Line skip'. You can also insert a page break.

        Returns:
      • getLabelId

        int getLabelId()

        Indicates the label identifier included in this edition line.

        Returns:
      • getStructureId

        int getStructureId()

        Indicates the structure identifier included in this edition line.

        Returns:
      • getTotalisationType

        ReportEditionLineTotalisationTypeValues getTotalisationType()

        Many Reports display a series of detail lines after the header.

        Some of these detail lines contain fields that are to be totalled.

        Other lines contain fields that are used to display the totals.

        This field, along with the Foreign total structure field, are then used to identify all these lines.

        Returns: