Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.edit.verifiers.comm.bridge
Class FDOUTStruct

java.lang.Object
  extended by com.ibm.etools.iseries.edit.verifiers.comm.bridge.FDOUTStruct

public class FDOUTStruct
extends Object

This class corresponds to the CODE comm FDOUT struct defined in evfcsys.h typedef struct { SHORT fieldType; Field type SHORT fieldLength; Field length SHORT decimal; Decimal position CHAR dattimfmt; Date/Time Format CHAR dattimsep; Date/Time Separator CHAR recName[11]; Record name CHAR libName[11]; Actual library name CHAR precision; float precision (E or D) CHAR dataType; Data type CHAR refShift; Reference shift CHAR usage; Usage CHAR alias[31]; Alias CHAR heading1[21]; Column heading 1 CHAR heading2[21]; Column heading 2 CHAR heading3[21]; Column heading 3 CHAR text[51]; Text CHAR code; Edit code CHAR padding; Padding CHARacter CHAR editWord[256]; Edit word CHAR reserved; Filler USHORT editLength; Edit word length USHORT allocLen; Allocated length USHORT ccsid; CCSID for field USHORT checkFlags; Validity check keywords USHORT igcFlags; IGC bits USHORT dtFlags; Date/Time bits USHORT typeFlags; Field type flags USHORT numKeyword; Number of validity check keywords } FDOUT;


Field Summary
static String copyright
           
 
Constructor Summary
FDOUTStruct(IQSYSDatabaseField field)
          Constructor for FDOUTStruct.
 
Method Summary
 String getAlias()
          Returns the alias.
 int getAllocLen()
          Returns the allocLen.
 int getCcsid()
          Returns the ccsid.
 int getCheckFlags()
          Returns the checkFlags.
 char getCode()
          Returns the edit code.
 char getDataType()
          Returns the dataType.
 char getDattimfmt()
          Returns the dattimfmt.
 char getDattimsep()
          Returns the dattimsep.
 short getDecimal()
          Returns the decimal.
 int getDigits()
          Returns the digits
static int getDtFlags(IISeriesHostDatabaseField field)
           
 int getEditLength()
          Returns the editLength.
 String getEditWord()
          Returns the editWord.
 short getFieldLength()
          Returns the fieldLength.
static short getFieldType(char datatype, boolean variableLength)
          Returns the fieldType.
 String getHeading1()
          Returns the heading1.
 String getHeading2()
          Returns the heading2.
 String getHeading3()
          Returns the heading3.
static int getIgcFlags(IISeriesHostDatabaseField field)
          Returns the igcFlags.
 String getLibName()
          Returns the libName.
 int getNumKeyword()
          Returns the numKeyword.
 char getPrecision()
          Returns the precision.
 String getRecName()
          Returns the recName.
 char getRefShift()
          Returns the refShift.
protected  String getText()
          Returns the text.
protected  int getTypeFlags()
          Returns the typeFlags.
 char getUsage()
          Returns the usage.
 void write(JavaToCOutputStream out)
          Stream the contents of this class to the ouput stream in the format required by the corresponding c structure.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Constructor Detail

FDOUTStruct

public FDOUTStruct(IQSYSDatabaseField field)
Constructor for FDOUTStruct.

Method Detail

write

public void write(JavaToCOutputStream out)
           throws IOException
Stream the contents of this class to the ouput stream in the format required by the corresponding c structure.

Throws:
IOException

getAlias

public String getAlias()
Returns the alias.

Returns:
String

getAllocLen

public int getAllocLen()
Returns the allocLen.

Returns:
int

getCcsid

public int getCcsid()
Returns the ccsid.

Returns:
int

getDigits

public int getDigits()
Returns the digits


getCheckFlags

public int getCheckFlags()
Returns the checkFlags.

Returns:
int

getCode

public char getCode()
Returns the edit code.

Returns:
char

getDataType

public char getDataType()
Returns the dataType.

Returns:
char

getDattimfmt

public char getDattimfmt()
Returns the dattimfmt.

Returns:
char

getDattimsep

public char getDattimsep()
Returns the dattimsep.

Returns:
char

getDecimal

public short getDecimal()
Returns the decimal.

Returns:
short

getDtFlags

public static int getDtFlags(IISeriesHostDatabaseField field)
Returns:
the date and time flags.

getEditLength

public int getEditLength()
Returns the editLength.

Returns:
int

getEditWord

public String getEditWord()
Returns the editWord.

Returns:
String

getFieldLength

public short getFieldLength()
Returns the fieldLength.

Returns:
short

getFieldType

public static short getFieldType(char datatype,
                                 boolean variableLength)
Returns the fieldType.

Returns:
short

getHeading1

public String getHeading1()
Returns the heading1.

Returns:
String

getHeading2

public String getHeading2()
Returns the heading2.

Returns:
String

getHeading3

public String getHeading3()
Returns the heading3.

Returns:
String

getIgcFlags

public static int getIgcFlags(IISeriesHostDatabaseField field)
Returns the igcFlags.

Returns:
int

getLibName

public String getLibName()
Returns the libName.

Returns:
String

getNumKeyword

public int getNumKeyword()
Returns the numKeyword.

Returns:
int

getPrecision

public char getPrecision()
Returns the precision.

Returns:
char

getRecName

public String getRecName()
Returns the recName.

Returns:
String

getRefShift

public char getRefShift()
Returns the refShift.

Returns:
char

getText

protected String getText()
Returns the text.

Returns:
String

getTypeFlags

protected int getTypeFlags()
Returns the typeFlags.

Returns:
int

getUsage

public char getUsage()
Returns the usage. Possable values (as returned by QDBRTVFD api (Qddffiob field): X'01' The field can be used for input only. X'02' Output only. X'03' Both input and output. X'04' Neither input nor output. X'FF' The usage is unknown.

Returns:
char

Rational Developer for Power Systems Software
V7.6

Copyright 2011 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.