com.ibm.pdp.maf.rpp.pac.copybook

Interface Copybook

  • All Superinterfaces:
    AbstractRadicalElement, Element, RadicalElement


    public interface Copybook
    extends AbstractRadicalElement

    This component is used to obtain descriptions of Data Structures or SQL Database Blocks in COBOL source language, using the data structure descriptions implemented in the System. 

    Each description thus obtained is stored in a COBOL source library and can be incorporated into programs using the COPY clause.

    • Method Detail

      • getBlockBase

        RelationalBlockBase getBlockBase()

        Indicates the blockbase for DSQC1 generation.

        Returns:
      • getCobolFolder

        java.lang.String getCobolFolder()

        Returns the project where the Copybook will be generated.

        Returns:
      • getCobolLocationCode

        CopybookCobolLocationCodeValues getCobolLocationCode()

        It indicates the location of the description in the generated program : in the FILE SECTION, the WORKING STORAGE SECTION, LINKAGE SECTION, or generation of a variable file

        Returns:
      • getCobolProject

        java.lang.String getCobolProject()

        Returns the project where the Copybook will be generated.

        Returns:
      • getCobolType

        CobolTypeValues getCobolType()

        It is the type of COBOL the generated description will be adapted to. This adaptation does not apply to the USAGE clauses.

        Returns:
      • getDataStructure

        DataStructure getDataStructure()

        In indicates the data structure the generation will concerns

        Returns:
      • getDataStructureCode

        java.lang.String getDataStructureCode()

        Data strucure code generated in the the copybook

        Returns:
      • getDSCodeType

        CopybookDSCodeTypeValues getDSCodeType()

        If value is None, no specific codification will be applied in data structure code.

        If A' selected, the data structure code will be prefixed with '

        A* corresponds to Alias generation

        Returns:
      • getEntitiesSelected

        java.util.List<CopybookEntitiesSelected> getEntitiesSelected()

        Gives the list of the segments on which the copybook will be applied

        Returns:
      • getExternalName

        java.lang.String getExternalName()

        It is the file name used in the programs and in the COPY clause. 

        This file name is eight-character long maximum. 

        Returns:
      • getFormatType

        ProgramFormatTypeValues getFormatType()

        Specify which type of Data Element format is to be used in the description.

        Returns:
      • getGenerationLibrary

        Library getGenerationLibrary()

        Indicates the Library on which we can find the generation parameters for the entity.

        These parameters are related to the adaptation to the operating system in use.

        Returns:
      • getGenerationType

        CopyBookGenerationTypeValues getGenerationType()

        You specify here whether the generated description must include the assigned Text lines or whether the description is to be used in VAP Connector.

        Returns:
      • getRecordLevel

        ProgramCobolRecordLevelValues getRecordLevel()

        It defines, with record type, the level number of the descriptions of Data Structures, records, or Data Elements. 

        Returns:
      • getRecordType

        ProgramGeneratedDescriptionTypeValues getRecordType()

        This field specifies different ways of arranging the records of a Data Structure in the description.

        Returns:
      • isInputAidParameter

        boolean isInputAidParameter()

        If true, the copybook will be generated from the values indicated on the DATA input aid call on -GC.

        Returns: