Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm.interfaces
Class ISeriesHostFieldBasic

java.lang.Object
  extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
      extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly
          extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldNameOnly
              extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldBasic
All Implemented Interfaces:
IISeriesHostFieldBasic, IISeriesHostFieldConstants, IISeriesHostFieldNameOnly, IISeriesHostObjectNameOnly, IISeriesHostRecordNameOnly
Direct Known Subclasses:
ISeriesHostDatabaseField, QSYSHostFileField

public class ISeriesHostFieldBasic
extends ISeriesHostFieldNameOnly
implements IISeriesHostFieldBasic

This class represents a single field on the AS/400. It holds all information about that object.


Field Summary
protected  String alternativeName
           
static String Copyright
           
protected  int dataCCSID
           
protected  char datatype
           
protected  int decPos
           
protected  Object dftValue
           
protected  int digits
           
protected  boolean dlControl
           
protected  char dlIntegrity
           
protected  char dlReadPermission
           
protected  boolean dlRecovery
           
protected  char dlUnlinkAction
           
protected  char dlWritePermission
           
protected  String dtFormat
           
protected  char dtSep
           
protected  String edtcde
           
protected  String edtwrd
           
protected  int edtwrdCCSID
           
protected  int encodingScheme
           
protected  boolean hasHostVariable
           
protected  String hdg1
           
protected  String hdg2
           
protected  String hdg3
           
protected  int hdgCCSID
           
protected  int inputBufferPos
           
protected  String internalName
           
protected  int length
           
protected  int maxLOBlen
           
protected  int maxLOBpadlen
           
protected  int nbrDBCSchars
           
protected  boolean nullValuesAllowed
           
protected  int outputBufferPos
           
protected  String text
           
protected  int textCCSID
           
protected  int ucs2Len
           
protected  String udtLib
           
protected  String udtName
           
protected  char use
           
protected  boolean varLen
           
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldNameOnly
record
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly
file, fileType
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
library, name
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostFieldConstants
DATALINK_INTEGRITY_DB, DATALINK_INTEGRITY_DLFM, DATALINK_READPERMISSION_DB, DATALINK_READPERMISSION_DLFM, DATALINK_UNLINK_DELETE, DATALINK_UNLINK_RESTORE, DATALINK_WRITEPERMISSION_DLFM, DATALINK_WRITEPERMISSION_NONE, DATATYPE_ALPHABETIC_ONLY, DATATYPE_ALPHANUMERIC, DATATYPE_BINARY, DATATYPE_BLOB, DATATYPE_CLOB, DATATYPE_DATALINK, DATATYPE_DATE, DATATYPE_DBCLOB, DATATYPE_DBCS_EITHER, DATATYPE_DBCS_ONLY, DATATYPE_DBCS_OPEN, DATATYPE_DIGITS_ONLY, DATATYPE_FLOAT, DATATYPE_GRAPHIC, DATATYPE_HEXADECIMAL, DATATYPE_INHIBIT, DATATYPE_KATAKANA, DATATYPE_NUMERIC_ONLY, DATATYPE_NUMERIC_SHIFT, DATATYPE_NUMERICONLY, DATATYPE_PACKED_DECIMAL, DATATYPE_TIME, DATATYPE_TIMESTAMP, DATATYPE_ZONED_DECIMAL, DATETIME_CDMY, DATETIME_CMDY, DATETIME_CYMD, DATETIME_DMY, DATETIME_DMYY, DATETIME_EUR, DATETIME_HMS, DATETIME_ISO, DATETIME_JIS, DATETIME_JUL, DATETIME_JUL4, DATETIME_MDY, DATETIME_MDYY, DATETIME_MY, DATETIME_MYY, DATETIME_SAA, DATETIME_USA, DATETIME_YM, DATETIME_YMD, DATETIME_YYM, DATETIME_YYMD
 
Constructor Summary
ISeriesHostFieldBasic()
           
 
Method Summary
 String getAlternativeName()
           
 int getBufferLength()
           
 String getColumnHeading1()
           
 String getColumnHeading2()
           
 String getColumnHeading3()
           
 int getColumnHeadingCCSID()
           
 int getDataCCSID()
           
 int getDataEncodingScheme()
           
 char getDatalinkIntegrity()
           
 char getDatalinkReadPermission()
           
 char getDatalinkUnlinkAction()
           
 char getDatalinkWritePermission()
           
 char getDataType()
          Get the field's data type.
 String getDateTimeFormat()
           
 char getDateTimeSeparator()
           
 int getDecimalPosition()
           
 Object getDefaultValue()
           
 String getDescription()
           
 int getDescriptionCCSID()
           
 int getDigits()
          For numeric fields, returns the total length including decimals
 String getEditCode()
           
 String getEditWord()
           
 int getEditWordCCSID()
           
 boolean getHasDatalinkControl()
           
 boolean getHasDatalinkRecovery()
           
 boolean getHasHostVariable()
           
 int getInputBufferPosition()
           
 String getInternalName()
           
 boolean getIsVariableLength()
           
 int getLargeObjectPadLength()
           
 int getLength()
          Return the total length for numeric fields, and the number of characters for character fields.
 int getMaxLargeObjectLength()
           
 int getNbrDBCSCharacters()
           
 boolean getNullValuesAllowed()
           
 int getOutputBufferPosition()
           
 int getUCS2DisplayedLength()
           
 char getUse()
          Get the field's usage.
 String getUserDefinedTypeLibrary()
           
 String getUserDefinedTypeName()
           
 boolean isDoublePrecision()
          For floating point fields (datatype == 'F') return true if the precision is double, false if it is single
 void setAlternativeName(String name)
           
 void setBufferLength(int len)
           
 void setColumnHeading1(String hdg)
           
 void setColumnHeading2(String hdg)
           
 void setColumnHeading3(String hdg)
           
 void setColumnHeadingCCSID(int ccsid)
           
 void setDataCCSID(int ccsid)
           
 void setDataEncodingScheme(int scheme)
           
 void setDatalinkIntegrity(char integrity)
           
 void setDatalinkReadPermission(char permission)
           
 void setDatalinkUnlinkAction(char action)
           
 void setDatalinkWritePermission(char permission)
           
 void setDataType(char type)
           
 void setDateTimeFormat(String format)
           
 void setDateTimeSeparator(char separator)
           
 void setDecimalPosition(int pos)
           
 void setDefaultValue(Object value)
           
 void setDescription(String text)
           
 void setDescriptionCCSID(int ccsid)
           
 void setDigits(int digits)
           
 void setEditCode(String code)
           
 void setEditWord(String word)
           
 void setEditWordCCSID(int ccsid)
           
 void setHasDatalinkControl(boolean has)
           
 void setHasDatalinkRecovery(boolean has)
           
 void setHasHostVariable(boolean has)
           
 void setInputBufferPosition(int pos)
           
 void setInternalName(String name)
           
 void setIsVariableLength(boolean is)
           
 void setLargeObjectPadLength(int len)
           
 void setMaxLargeObjectLength(int len)
           
 void setNbrDBCSCharacters(int nbr)
           
 void setNullValuesAllowed(boolean allowed)
           
 void setOutputBufferPosition(int pos)
           
 void setUCS2DisplayedLength(int len)
           
 void setUse(char use)
           
 void setUserDefinedTypeLibrary(String library)
           
 void setUserDefinedTypeName(String name)
           
 void writeObjectInfo(PrintWriter writer)
          For debugging purposes
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldNameOnly
getRecord, setRecord, toString
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostRecordNameOnly
getFile, getFileType, setFile, setFileType
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
getLibrary, getName, setLibrary, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostFieldNameOnly
getRecord, setRecord, toString
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordNameOnly
getFile, getFileType, setFile, setFileType
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
getLibrary, getName, setLibrary, setName
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values

datatype

protected char datatype

use

protected char use

dtSep

protected char dtSep

dlIntegrity

protected char dlIntegrity

dlReadPermission

protected char dlReadPermission

dlWritePermission

protected char dlWritePermission

dlUnlinkAction

protected char dlUnlinkAction

text

protected String text

edtcde

protected String edtcde

edtwrd

protected String edtwrd

hdg1

protected String hdg1

hdg2

protected String hdg2

hdg3

protected String hdg3

alternativeName

protected String alternativeName

internalName

protected String internalName

dtFormat

protected String dtFormat

udtName

protected String udtName

udtLib

protected String udtLib

length

protected int length

outputBufferPos

protected int outputBufferPos

inputBufferPos

protected int inputBufferPos

digits

protected int digits

decPos

protected int decPos

nbrDBCSchars

protected int nbrDBCSchars

textCCSID

protected int textCCSID

hdgCCSID

protected int hdgCCSID

dataCCSID

protected int dataCCSID

edtwrdCCSID

protected int edtwrdCCSID

ucs2Len

protected int ucs2Len

encodingScheme

protected int encodingScheme

maxLOBlen

protected int maxLOBlen

maxLOBpadlen

protected int maxLOBpadlen

nullValuesAllowed

protected boolean nullValuesAllowed

hasHostVariable

protected boolean hasHostVariable

varLen

protected boolean varLen

dlControl

protected boolean dlControl

dlRecovery

protected boolean dlRecovery

dftValue

protected Object dftValue
Constructor Detail

ISeriesHostFieldBasic

public ISeriesHostFieldBasic()
Method Detail

setDataType

public void setDataType(char type)
Specified by:
setDataType in interface IISeriesHostFieldBasic

setUse

public void setUse(char use)
Specified by:
setUse in interface IISeriesHostFieldBasic

setOutputBufferPosition

public void setOutputBufferPosition(int pos)
Specified by:
setOutputBufferPosition in interface IISeriesHostFieldBasic

setInputBufferPosition

public void setInputBufferPosition(int pos)
Specified by:
setInputBufferPosition in interface IISeriesHostFieldBasic

setBufferLength

public void setBufferLength(int len)
Specified by:
setBufferLength in interface IISeriesHostFieldBasic

setDigits

public void setDigits(int digits)
Specified by:
setDigits in interface IISeriesHostFieldBasic

setDecimalPosition

public void setDecimalPosition(int pos)
Specified by:
setDecimalPosition in interface IISeriesHostFieldBasic

setDescription

public void setDescription(String text)
Specified by:
setDescription in interface IISeriesHostFieldBasic

setEditCode

public void setEditCode(String code)
Specified by:
setEditCode in interface IISeriesHostFieldBasic

setEditWord

public void setEditWord(String word)
Specified by:
setEditWord in interface IISeriesHostFieldBasic

setColumnHeading1

public void setColumnHeading1(String hdg)
Specified by:
setColumnHeading1 in interface IISeriesHostFieldBasic

setColumnHeading2

public void setColumnHeading2(String hdg)
Specified by:
setColumnHeading2 in interface IISeriesHostFieldBasic

setColumnHeading3

public void setColumnHeading3(String hdg)
Specified by:
setColumnHeading3 in interface IISeriesHostFieldBasic

setInternalName

public void setInternalName(String name)
Specified by:
setInternalName in interface IISeriesHostFieldBasic

setAlternativeName

public void setAlternativeName(String name)
Specified by:
setAlternativeName in interface IISeriesHostFieldBasic

setNbrDBCSCharacters

public void setNbrDBCSCharacters(int nbr)
Specified by:
setNbrDBCSCharacters in interface IISeriesHostFieldBasic

setNullValuesAllowed

public void setNullValuesAllowed(boolean allowed)
Specified by:
setNullValuesAllowed in interface IISeriesHostFieldBasic

setHasHostVariable

public void setHasHostVariable(boolean has)
Specified by:
setHasHostVariable in interface IISeriesHostFieldBasic

setDateTimeFormat

public void setDateTimeFormat(String format)
Specified by:
setDateTimeFormat in interface IISeriesHostFieldBasic

setDateTimeSeparator

public void setDateTimeSeparator(char separator)
Specified by:
setDateTimeSeparator in interface IISeriesHostFieldBasic

setIsVariableLength

public void setIsVariableLength(boolean is)
Specified by:
setIsVariableLength in interface IISeriesHostFieldBasic

setDescriptionCCSID

public void setDescriptionCCSID(int ccsid)
Specified by:
setDescriptionCCSID in interface IISeriesHostFieldBasic

setDataCCSID

public void setDataCCSID(int ccsid)
Specified by:
setDataCCSID in interface IISeriesHostFieldBasic

setColumnHeadingCCSID

public void setColumnHeadingCCSID(int ccsid)
Specified by:
setColumnHeadingCCSID in interface IISeriesHostFieldBasic

setEditWordCCSID

public void setEditWordCCSID(int ccsid)
Specified by:
setEditWordCCSID in interface IISeriesHostFieldBasic

setUCS2DisplayedLength

public void setUCS2DisplayedLength(int len)
Specified by:
setUCS2DisplayedLength in interface IISeriesHostFieldBasic

setDataEncodingScheme

public void setDataEncodingScheme(int scheme)
Specified by:
setDataEncodingScheme in interface IISeriesHostFieldBasic

setMaxLargeObjectLength

public void setMaxLargeObjectLength(int len)
Specified by:
setMaxLargeObjectLength in interface IISeriesHostFieldBasic

setLargeObjectPadLength

public void setLargeObjectPadLength(int len)
Specified by:
setLargeObjectPadLength in interface IISeriesHostFieldBasic

setUserDefinedTypeName

public void setUserDefinedTypeName(String name)
Specified by:
setUserDefinedTypeName in interface IISeriesHostFieldBasic

setUserDefinedTypeLibrary

public void setUserDefinedTypeLibrary(String library)
Specified by:
setUserDefinedTypeLibrary in interface IISeriesHostFieldBasic

setHasDatalinkControl

public void setHasDatalinkControl(boolean has)
Specified by:
setHasDatalinkControl in interface IISeriesHostFieldBasic

setDatalinkIntegrity

public void setDatalinkIntegrity(char integrity)
Specified by:
setDatalinkIntegrity in interface IISeriesHostFieldBasic

setDatalinkReadPermission

public void setDatalinkReadPermission(char permission)
Specified by:
setDatalinkReadPermission in interface IISeriesHostFieldBasic

setDatalinkWritePermission

public void setDatalinkWritePermission(char permission)
Specified by:
setDatalinkWritePermission in interface IISeriesHostFieldBasic

setHasDatalinkRecovery

public void setHasDatalinkRecovery(boolean has)
Specified by:
setHasDatalinkRecovery in interface IISeriesHostFieldBasic

setDatalinkUnlinkAction

public void setDatalinkUnlinkAction(char action)
Specified by:
setDatalinkUnlinkAction in interface IISeriesHostFieldBasic

setDefaultValue

public void setDefaultValue(Object value)
Specified by:
setDefaultValue in interface IISeriesHostFieldBasic

getDataType

public char getDataType()
Get the field's data type. Valid types are:

Specified by:
getDataType in interface IISeriesHostFieldBasic

getUse

public char getUse()
Get the field's usage. Value is one of:

Specified by:
getUse in interface IISeriesHostFieldBasic

getOutputBufferPosition

public int getOutputBufferPosition()
Specified by:
getOutputBufferPosition in interface IISeriesHostFieldBasic

getInputBufferPosition

public int getInputBufferPosition()
Specified by:
getInputBufferPosition in interface IISeriesHostFieldBasic

getBufferLength

public int getBufferLength()
Specified by:
getBufferLength in interface IISeriesHostFieldBasic

getLength

public int getLength()
Return the total length for numeric fields, and the number of characters for character fields. For DBCS fields this will be the number of bytes, not characters. To get number of characters, see getNbrDBCSCharacters().

Specified by:
getLength in interface IISeriesHostFieldBasic

isDoublePrecision

public boolean isDoublePrecision()
For floating point fields (datatype == 'F') return true if the precision is double, false if it is single

Specified by:
isDoublePrecision in interface IISeriesHostFieldBasic

getDigits

public int getDigits()
For numeric fields, returns the total length including decimals

Specified by:
getDigits in interface IISeriesHostFieldBasic

getDecimalPosition

public int getDecimalPosition()
Specified by:
getDecimalPosition in interface IISeriesHostFieldBasic

getDescription

public String getDescription()
Specified by:
getDescription in interface IISeriesHostFieldBasic

getEditCode

public String getEditCode()
Specified by:
getEditCode in interface IISeriesHostFieldBasic

getEditWord

public String getEditWord()
Specified by:
getEditWord in interface IISeriesHostFieldBasic

getColumnHeading1

public String getColumnHeading1()
Specified by:
getColumnHeading1 in interface IISeriesHostFieldBasic

getColumnHeading2

public String getColumnHeading2()
Specified by:
getColumnHeading2 in interface IISeriesHostFieldBasic

getColumnHeading3

public String getColumnHeading3()
Specified by:
getColumnHeading3 in interface IISeriesHostFieldBasic

getInternalName

public String getInternalName()
Specified by:
getInternalName in interface IISeriesHostFieldBasic

getAlternativeName

public String getAlternativeName()
Specified by:
getAlternativeName in interface IISeriesHostFieldBasic

getNbrDBCSCharacters

public int getNbrDBCSCharacters()
Specified by:
getNbrDBCSCharacters in interface IISeriesHostFieldBasic

getNullValuesAllowed

public boolean getNullValuesAllowed()
Specified by:
getNullValuesAllowed in interface IISeriesHostFieldBasic

getHasHostVariable

public boolean getHasHostVariable()
Specified by:
getHasHostVariable in interface IISeriesHostFieldBasic

getDateTimeFormat

public String getDateTimeFormat()
Specified by:
getDateTimeFormat in interface IISeriesHostFieldBasic

getDateTimeSeparator

public char getDateTimeSeparator()
Specified by:
getDateTimeSeparator in interface IISeriesHostFieldBasic

getIsVariableLength

public boolean getIsVariableLength()
Specified by:
getIsVariableLength in interface IISeriesHostFieldBasic

getDescriptionCCSID

public int getDescriptionCCSID()
Specified by:
getDescriptionCCSID in interface IISeriesHostFieldBasic

getDataCCSID

public int getDataCCSID()
Specified by:
getDataCCSID in interface IISeriesHostFieldBasic

getColumnHeadingCCSID

public int getColumnHeadingCCSID()
Specified by:
getColumnHeadingCCSID in interface IISeriesHostFieldBasic

getEditWordCCSID

public int getEditWordCCSID()
Specified by:
getEditWordCCSID in interface IISeriesHostFieldBasic

getUCS2DisplayedLength

public int getUCS2DisplayedLength()
Specified by:
getUCS2DisplayedLength in interface IISeriesHostFieldBasic

getDataEncodingScheme

public int getDataEncodingScheme()
Specified by:
getDataEncodingScheme in interface IISeriesHostFieldBasic

getMaxLargeObjectLength

public int getMaxLargeObjectLength()
Specified by:
getMaxLargeObjectLength in interface IISeriesHostFieldBasic

getLargeObjectPadLength

public int getLargeObjectPadLength()
Specified by:
getLargeObjectPadLength in interface IISeriesHostFieldBasic

getUserDefinedTypeName

public String getUserDefinedTypeName()
Specified by:
getUserDefinedTypeName in interface IISeriesHostFieldBasic

getUserDefinedTypeLibrary

public String getUserDefinedTypeLibrary()
Specified by:
getUserDefinedTypeLibrary in interface IISeriesHostFieldBasic

getHasDatalinkControl

public boolean getHasDatalinkControl()
Specified by:
getHasDatalinkControl in interface IISeriesHostFieldBasic

getDatalinkIntegrity

public char getDatalinkIntegrity()
Specified by:
getDatalinkIntegrity in interface IISeriesHostFieldBasic

getDatalinkReadPermission

public char getDatalinkReadPermission()
Specified by:
getDatalinkReadPermission in interface IISeriesHostFieldBasic

getDatalinkWritePermission

public char getDatalinkWritePermission()
Specified by:
getDatalinkWritePermission in interface IISeriesHostFieldBasic

getHasDatalinkRecovery

public boolean getHasDatalinkRecovery()
Specified by:
getHasDatalinkRecovery in interface IISeriesHostFieldBasic

getDatalinkUnlinkAction

public char getDatalinkUnlinkAction()
Specified by:
getDatalinkUnlinkAction in interface IISeriesHostFieldBasic

getDefaultValue

public Object getDefaultValue()
Specified by:
getDefaultValue in interface IISeriesHostFieldBasic

writeObjectInfo

public void writeObjectInfo(PrintWriter writer)
For debugging purposes

Specified by:
writeObjectInfo in interface IISeriesHostFieldNameOnly
Specified by:
writeObjectInfo in interface IISeriesHostObjectNameOnly
Specified by:
writeObjectInfo in interface IISeriesHostRecordNameOnly
Overrides:
writeObjectInfo in class ISeriesHostFieldNameOnly

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.