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

All Superinterfaces:
AbstractRadicalElement, DataDefinition, Element, RadicalElement

public interface DataElement
extends AbstractRadicalElement, DataDefinition

The purpose of the Data Element entity is to identify and describe all pieces of information used by the company applications.

A Data Element is a unit of data, considered as 'elementary' during at least one stage in the development of a project.


Field Summary
static java.lang.String copyright
           
 
Method Summary
 DataElementBlankWhenZeroValues getBlankWhenZero()
          

if the Blank when zero COBOL clause is generated, blanks replace the zero values that are normally printed or displayed.

 java.util.List<DataElement> getChildrenDataElements()
          Returns the list of children data elements.
 java.util.List<DataElementDescription> getDLines()
          The DLines of an data element correspond to the Data Element Description.
 java.util.List<GLine> getGELines()
          GELines specify the automatically generated error messages, declare explicit error messages, or specify help on a Data Element or an error message.
 Library getGenerationLibrary()
          Indicates the Library on which we can find the generation parameters for the entity.
 java.lang.String getInputFormat()
          The input format is specific to the Batch Applications function.
 java.lang.String getInternalFormat()
          The internal format is required, except if the Data Element is a Property.
 DataElementInternalUsageValues getInternalUsage()
          The internal usage corresponds to the COBOL USAGE clause.
 java.lang.String getOutputFormat()
          The output format is used when the Data Element describes:

    A field in a Report

    A protected field in a Screen, if no conversational format has been specified

 DataElement getParent()
          Indicates the parent of the data element.
 DataElementTypeValues getType()
          Indicates the type of the data element : R for a real data element, L for a large object, P for a property, A for an Alias data element and U for an Unicode data element.
 
Methods inherited from interface com.ibm.pdp.maf.rpp.pac.common.AbstractRadicalElement
getGCLines
 
Methods inherited from interface com.ibm.pdp.maf.rpp.kernel.DataDefinition
getDataDescription
 
Methods inherited from interface com.ibm.pdp.maf.rpp.kernel.RadicalElement
getDescriptionTypes, getKeywords, getLabel, getName, getPackage, getProject
 

Field Detail

copyright

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

getBlankWhenZero

DataElementBlankWhenZeroValues getBlankWhenZero()

if the Blank when zero COBOL clause is generated, blanks replace the zero values that are normally printed or displayed.

It only applies to numeric Data Elements, for the retrieval of old versions.

Returns:

getChildrenDataElements

java.util.List<DataElement> getChildrenDataElements()

Returns the list of children data elements.

Returns:

getDLines

java.util.List<DataElementDescription> getDLines()

The DLines of an data element correspond to the Data Element Description.

It 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

Returns:

getGELines

java.util.List<GLine> getGELines()

GELines specify the automatically generated error messages, declare explicit error messages, or specify help on a Data Element or an error message.

Returns:

getGenerationLibrary

Library getGenerationLibrary()

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

Parameters are related to the adaptation to the operating system in use.

Returns:

getInputFormat

java.lang.String getInputFormat()

The input format is specific to the Batch Applications function. It is required when the Data Element is called in a transaction file, used as input in a batch flow.

Returns:

getInternalFormat

java.lang.String getInternalFormat()

The internal format is required, except if the Data Element is a Property.

The internal format is used when the Data Element is called in:

Returns:

getInternalUsage

DataElementInternalUsageValues getInternalUsage()

The internal usage corresponds to the COBOL USAGE clause.

With the USAGE clause of a COBOL numeric variable, you indicate the internal representation of its value. Different usages are available depending on the COBOL variants adapted to the material in use.

Returns:

getOutputFormat

java.lang.String getOutputFormat()

The output format is used when the Data Element describes:

Returns:

getParent

DataElement getParent()

Indicates the parent of the data element.

Data Element is an elementary concept. In your applications, you might want to use several technical variants of this concept. So to guarantee the coherence of your data, you manage these variants by creating parent and child Data Elements.

The characteristics of the parent Data Element (its formats and its usage) are passed on to its child but can modify the characteristics inherited from its parent.

Returns:

getType

DataElementTypeValues getType()

Indicates the type of the data element : R for a real data element, L for a large object, P for a property, A for an Alias data element and U for an Unicode data element.

Returns: