iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.editor.generator.model
Class DataAreaDSpec

java.lang.Object
  extended bycom.ibm.etools.iseries.editor.generator.model.RPGCommon
      extended bycom.ibm.etools.iseries.editor.generator.model.DataStructureDSpec
          extended bycom.ibm.etools.iseries.editor.generator.model.DataAreaDSpec
All Implemented Interfaces:
IDSpec

public class DataAreaDSpec
extends DataStructureDSpec


Field Summary
protected  boolean inzLikeDS
           
protected  boolean likeDS
           
protected  String likeDSName
           
 
Fields inherited from class com.ibm.etools.iseries.editor.generator.model.DataStructureDSpec
altSeq, based, basedName, dataArea, dataAreaName, exportField, exportFieldName, importField, importFieldName, inz, occurs, qualified, staticValue, subFields
 
Fields inherited from class com.ibm.etools.iseries.editor.generator.model.RPGCommon
fieldName, purpose
 
Fields inherited from interface com.ibm.etools.iseries.editor.generator.model.IDSpec
DATEFMT_DMY, DATEFMT_EUR, DATEFMT_ISO, DATEFMT_JIS, DATEFMT_JUL, DATEFMT_MDY, DATEFMT_NONE, DATEFMT_USA, DATEFMT_YMD, DT_AMPERSAND, DT_COLON, DT_COMMA, DT_DASH, DT_NONE, DT_PERIOD, DT_SLASH, INFDS_DB, INFDS_DSPF_ATTR, INFDS_DSPF_DEV, INFDS_FILE, INFDS_ICF_ATTR, INFDS_ICF_DEV, INFDS_IO, INFDS_OPEN, INFDS_PRTF, MSG_ERR_REQ_FIELD, RPGARRAYKWD_B, RPGARRAYKWD_F, RPGARRAYKWD_I, RPGARRAYKWD_L, RPGARRAYKWD_P, RPGARRAYKWD_R, RPGARRAYKWD_S, RPGARRAYKWD_U, RPGTYPE_A, RPGTYPE_AV, RPGTYPE_B, RPGTYPE_C, RPGTYPE_CV, RPGTYPE_D, RPGTYPE_F, RPGTYPE_G, RPGTYPE_GV, RPGTYPE_I, RPGTYPE_I2, RPGTYPE_N, RPGTYPE_P, RPGTYPE_S, RPGTYPE_STAR, RPGTYPE_T, RPGTYPE_U, RPGTYPE_U2, RPGTYPE_Z, TIMEFMT_EUR, TIMEFMT_HMS, TIMEFMT_ISO, TIMEFMT_JIS, TIMEFMT_NONE, TIMEFMT_USA
 
Constructor Summary
DataAreaDSpec()
           
 
Method Summary
 String getLikeDSName()
           
 boolean isInzLikeDS()
           
 boolean isLikeDS()
           
 boolean isValid()
           
 void setInzLikeDS(boolean init)
          Sets whether or not this data structure is initialized with the initial values of its parent data structure.
 void setLikeDS(boolean b)
          Sets whether this data structure is defined to have the same subfields as another data structure.
 void setLikeDSName(String name)
          If this data structure is defined to have the same subfields as another data structure (LIKEDS), sets the name of that other data structure, otherwise, has no effect.
 
Methods inherited from class com.ibm.etools.iseries.editor.generator.model.DataStructureDSpec
addSubField, getBasedName, getDataAreaName, getExportFieldName, getImportFieldName, getOccurs, getSubField, getSubFields, ignoreAltSeq, isAssociatedWithDataArea, isBased, isExportField, isImportField, isInz, isQualified, isStatic, removeSubField, removeSubField, setAssociatedWithDataArea, setBased, setBasedName, setDataAreaName, setExportField, setExportFieldName, setIgnoreAltSeq, setImportField, setImportFieldName, setInz, setOccurs, setQualified, setStatic, swapSubFields
 
Methods inherited from class com.ibm.etools.iseries.editor.generator.model.RPGCommon
getMessages, getName, getPurpose, setFieldName, setPurpose
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

inzLikeDS

protected boolean inzLikeDS

likeDS

protected boolean likeDS

likeDSName

protected String likeDSName
Constructor Detail

DataAreaDSpec

public DataAreaDSpec()
Method Detail

isInzLikeDS

public boolean isInzLikeDS()
Returns:
Whether to initialize the data structure with initial values of its parent data structure.
See Also:
setInzLikeDS(boolean), isLikeDS(), setLikeDS(boolean), #getLikeDSame(), setLikeDSName(String)

isLikeDS

public boolean isLikeDS()
Returns:
Whether this data structure is defined to have the same subfields as another data structure.
See Also:
isInzLikeDS(), setLikeDS(boolean), setInzLikeDS(boolean), #getLikeDSame(), setLikeDSName(String)

getLikeDSName

public String getLikeDSName()
Returns:
If this data structure is defined to have the same subfields as another data structure (LIKEDS), returns the name of the other data structure, otherwise returns "".
See Also:
isInzLikeDS(), isLikeDS(), setLikeDS(boolean), setInzLikeDS(boolean), setLikeDSName(String)

setInzLikeDS

public void setInzLikeDS(boolean init)
Sets whether or not this data structure is initialized with the initial values of its parent data structure.

Parameters:
init - is true if and only if the data structure is to be initialized with the same initial values as its parent.
See Also:
isInzLikeDS(), isLikeDS(), getLikeDSName(), setLikeDS(boolean), setLikeDSName(String)

setLikeDS

public void setLikeDS(boolean b)
Sets whether this data structure is defined to have the same subfields as another data structure.

Parameters:
b - is true if and only if the data structure is to be defined with the same subfields as another data structure.
See Also:
isInzLikeDS(), isLikeDS(), getLikeDSName(), setInzLikeDS(boolean), setLikeDSName(String)

setLikeDSName

public void setLikeDSName(String name)
If this data structure is defined to have the same subfields as another data structure (LIKEDS), sets the name of that other data structure, otherwise, has no effect.

Parameters:
name - the name of the other data structure
See Also:
isInzLikeDS(), isLikeDS(), getLikeDSName(), setInzLikeDS(boolean), setLikeDS(boolean)

isValid

public boolean isValid()
Overrides:
isValid in class DataStructureDSpec
Returns:
Whether or not this data structure is well defined, ie: all required fields have been filled in, and there are no contradictory boolean fields.

iSeries Remote Systems
v6.0.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.