public interface Report extends AbstractRadicalElement
The Report entity is used to define and describe a Report. A Report is a document containing formatted data that results from running a query and applying a form to it. A Report must be called into a Program instance to be generated.
The Report entity is used to describe the layout of the Report and specify the general characteristics relating to the printing of the Report.
A Report contains :
the edition characteristics of the Report,
the printing composition: the categories,
a layout: position the labels and target Data Elements to create the categories, indicate the source of these Data Elements and the conditions under which the source is to be transferred to its targets.
A Report cannot be generated by itself, it must be called into a Program instance. A Report can be defined once and used in several Programs. During the generation of the Program instance, the Report is taken into account and the code necessary to manage the Report is placed into the source code for the Program instance.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Modifier and Type | Method and Description |
---|---|
java.util.List<CELine> |
getCELines() |
java.lang.String |
getComment() |
int |
getDecimalPartLength() |
java.util.List<DLine> |
getDLines() |
java.lang.String |
getEditionComment() |
java.lang.String |
getEditionCondition() |
int |
getIntegerPartLength() |
int |
getLabelLength() |
int |
getLineLength() |
int |
getLinesPerPage() |
java.util.List<LLine> |
getLLines() |
ReportNatureValues |
getNature() |
int |
getSectionPriority() |
int |
getTableSize() |
ReportTypeValues |
getType() |
ReportWriteOptionValues |
getWriteOption() |
getGCLines
getCalledEntities, getDescriptionTypes, getKeywords, getLabel, getName, getPackage, getProject
static final java.lang.String copyright
java.util.List<CELine> getCELines()
Displays the Data Elements called in the current Report layout.
java.lang.String getComment()
Comment for information only. The comment length must not exceed 36 characters.
int getDecimalPartLength()
This field, along with the IntegerParthLength, is used to define the format of the total counters.
Internal counters are generated when the Report contains target Data Elements which must be totaled. The total number of digits of both fields must remain within the limit authorized by the compiler.
Indicate the number of digits to the right of the decimal. The default value is 7.
java.util.List<DLine> getDLines()
Displays the categories specified for the Report layout.
java.lang.String getEditionComment()
The comment refers to the printing of the whole Report. The comment is limited to 36 characters.
java.lang.String getEditionCondition()
Conditions for the execution of the Report.
int getIntegerPartLength()
This field, along with the next one, is used to define the format of the total counters.
Internal counters are generated when the Report contains target Data Elements which must be totaled.
The total number of digits of both fields must remain within the limit authorized by the compiler.
Enter the number of digits to the left of the decimal. This value must be greater than 00. The default value is 11.
int getLabelLength()
The Label length field is used to identify the length of the longest Report constant line. It is the maximum number of characters on a line that is to be printed.
The default value is 132.
You must enter a value between 0 and 264.
The length indicated in this field is taken into account at generation time for the calculation of the WORKING-STORAGE SECTION length for the Report description
int getLineLength()
This value identifies the length of the longest Report constant line which is taken in account at generation. It is a pure numeric value from 1 to 264. The default option is 132.
Note: The actual length of the Report to be printed is determined from the value entered on the Label length
Example: You might want a Report containing technical comments in columns 81 - 132 but truncate the display in the Report for the users to the 80th column. You must then use the 132 default here, and enter 80 as the value of the Label length field in this tab.
int getLinesPerPage()
Number of lines per page to be printed. The default value is 60.
java.util.List<LLine> getLLines()
Displays the label lines specified on the Report layout.
ReportNatureValues getNature()
Nature of the Report. It is used to restrict the list of Reports to those of the specified nature.
int getSectionPriority()
This field is used with hardware requiring program segmentation due to small memory capacity.
It generates a Segment type overlay between print functions in a program.
It must only be used if the input Data Structures to print Programs are sorted by Report code and if the COBOL variant is ANSI. A priority less than 50 generates an overlay only in association with the SEGMENT LIMIT clause, to be inserted in the ENVIRONMENT DIVISION.
int getTableSize()
This field is used to indicate the number of positions to allocate in the category table for the different categories in the Report upon generation.
The default value is 100 lines.
The number of lines must not be greater than 1000, otherwise the table is not generated. If you enter the 0000 value, rather than using the category table to control the organization of printing for the categories, the categories are printed directly.
ReportTypeValues getType()
Type of printer.
ReportWriteOptionValues getWriteOption()
Write option.