com.ibm.pdp.maf.rpp.pac.program
Interface CDLine

All Superinterfaces:
Element
All Known Subinterfaces:
CDLineDataStructure, CDLineReport

public interface CDLine
extends Element

The purpose of the CDLine is to identify the external resources of a Program.

You can have resources represented by Data Structure or by Report.

Some infomations are common to the both type of CDLine like :


Field Summary
static java.lang.String copyright
           
 
Method Summary
 ProgramAccesModeValues getAccessMode()
          Indicates the way the Data Structure is accessed by the Program
 ProgramBlockModeValues getBlockMode()
          This field generates the RECORDING MODE IS clause, which indicates the nature of the logical records of the file.
 java.lang.String getCobolPosition()
          This field can contain two characters.
 ProgramCobolRecordLevelValues getCobolRecordLevel()
          This option is used with the Generated description type field.
 java.lang.String getExternalName()
          This field is optional, on six characters maximum.
 ProgramFormatTypeValues getFormatType()
          It is format of the Data Elements called in the Segments of the Data Structure.
 ProgramGeneratedDescriptionTypeValues getGeneratedDescriptionType()
          It is the type of record description to be used in the COBOL program to allow different uses of the Segment description stored in the Library.
 ProgramIOModeValues getIOMode()
          Indicates the opening mode of the Data Structure.
 ProgramOrganizationValues getOrganization()
          Give the organization of the DataStructure or The Report, whether the Data Structure must be generated in the WORKING-STORAGE SECTION, or as the description of a Pactables Table.
 java.lang.String getSubScheme()
          A subschema is a group of Data Elements called in the Segment.
 ProgramUnitTypeValues getUnitType()
          The value of this field is important in the Types of COBOL code for which the ASSIGN clause, the FD level and the WRITE statements are dependent on the selected unit type.
 ProgramUsageValues getUsage()
          This code defines the role of the Data Structure in the Program and determines the generated functions.
 

Field Detail

copyright

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

getAccessMode

ProgramAccesModeValues getAccessMode()

Indicates the way the Data Structure is accessed by the Program

Returns:

getBlockMode

ProgramBlockModeValues getBlockMode()

This field generates the RECORDING MODE IS clause, which indicates the nature of the logical records of the file.

Returns:

getCobolPosition

java.lang.String getCobolPosition()

This field can contain two characters. It concerns the main description of a Data Structure (ddss) and not the descriptions which are preceded by a prefix (1-ddss or 2-ddss).

This field is used to obtain a Data Structure description in a particular area (communication area with DBMS or LINKAGE SECTION) or at the beginning of the WORKING-STORAGE SECTION.

This field is reserved for Data Structures whose organization is W: File description in Working or L: Working with placement.

To obtain the description of a Data Structure in the WORKING-STORAGE SECTION, you are advised to indicate it in the work area lines of the COBOL code, using micropatterns.

Values of the COBOL position Value Meaning :

The description and work areas are found at the beginning of the WORKING-STORAGE SECTION of the generated program. These lines are displayed before the Data Structures whose organization is W: File description in Working and before the Data Structures whose code in the Program is greater than this alphabetic code.

Note: Do not select a COBOL position identical to the Data Structure code in the program for a Data Structure with a W: File description in Working organization.

The work area lines and the description can be found in the generated program, at the end of the WORKING-STORAGE SECTION among the user areas.

Returns:

getCobolRecordLevel

ProgramCobolRecordLevelValues getCobolRecordLevel()

This option is used with the Generated description type field.

It defines the COBOL level number for the descriptions of Data Structures, Segments and Data Elements.

Returns:

getExternalName

java.lang.String getExternalName()

This field is optional, on six characters maximum. Its contents vary according to the Data Structure type and organization.

For the Y: Pacbench C/S organization, this field must contain the code of the COBOL COPY clause which represents the communication area of the Pacbench C/S Application Component which accesses the Logical View.

For an SQL database Data Structure, this field must contain the code of the SQL Block.

For any other Data Structure, the contents of this field depend on the value of the Type of COBOL code in the Program Definition tab :

Returns:

getFormatType

ProgramFormatTypeValues getFormatType()

It is format of the Data Elements called in the Segments of the Data Structure.

You must select the format according to the usage of the Data Structure. This field does not apply to the Data Structures whose usage is I: Direct printing or J: Indirect printing.

Note: The Data Elements making up the Segments must not exceed 999 characters.

Returns:

getGeneratedDescriptionType

ProgramGeneratedDescriptionTypeValues getGeneratedDescriptionType()

It is the type of record description to be used in the COBOL program to allow different uses of the Segment description stored in the Library.

Returns:

getIOMode

ProgramIOModeValues getIOMode()

Indicates the opening mode of the Data Structure.

In the external view, it determines whether the Data Structure will be inserted in the top part (for an input opening mode) or bottom part (for an output opening mode) of the view.

Returns:

getOrganization

ProgramOrganizationValues getOrganization()

Give the organization of the DataStructure or The Report, whether the Data Structure must be generated in the WORKING-STORAGE SECTION, or as the description of a Pactables Table.

This field is also used to specify database descriptions when the Database Description function is not used. These values are taken into account by application Programs.

Returns:

getSubScheme

java.lang.String getSubScheme()

A subschema is a group of Data Elements called in the Segment.

This field is used with the Pactables function, to indicate which subschema is to be described. It is numeric, from 0 to 9 (0 corresponds to subschema 10).

Returns:

getUnitType

ProgramUnitTypeValues getUnitType()

The value of this field is important in the Types of COBOL code for which the ASSIGN clause, the FD level and the WRITE statements are dependent on the selected unit type.

Returns:

getUsage

ProgramUsageValues getUsage()

This code defines the role of the Data Structure in the Program and determines the generated functions.

Returns: