com.ibm.etools.iseries.comm.interfaces
Interface IISeriesHostFieldBasic

All Superinterfaces:

IISeriesHostFieldConstants, IISeriesHostFieldNameOnly, IISeriesHostObjectNameOnly, IISeriesHostRecordNameOnly

All Known Subinterfaces:

IISeriesHostDatabaseField, IQSYSDatabaseField, IQSYSFileField

All Known Implementing Classes:

ISeriesHostDatabaseField, ISeriesHostFieldBasic, QSYSHostDatabaseField, QSYSHostFileField, QSYSRemoteDatabaseField, QSYSRemoteFileField

public interface IISeriesHostFieldBasic
extends IISeriesHostFieldNameOnly, IISeriesHostFieldConstants

This interface represents a single file field on the AS/400. It holds all information as returned by the QUSLFLD API, format FLDL0200. See Constant definitions moved to IISeriesHostFieldConstants.

Field Summary

static String

Copyright

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

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)

Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostFieldNameOnly

getRecord, setRecord, toString, writeObjectInfo

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

static final String Copyright

See Also:

Constant Field Values

Method Detail

setDataType

void setDataType(char type)

setUse

void setUse(char use)

setOutputBufferPosition

void setOutputBufferPosition(int pos)

setInputBufferPosition

void setInputBufferPosition(int pos)

setBufferLength

void setBufferLength(int len)

setDigits

void setDigits(int digits)

setDecimalPosition

void setDecimalPosition(int pos)

setDescription

void setDescription(String text)

setEditCode

void setEditCode(String code)

setEditWord

void setEditWord(String word)

setColumnHeading1

void setColumnHeading1(String hdg)

setColumnHeading2

void setColumnHeading2(String hdg)

setColumnHeading3

void setColumnHeading3(String hdg)

setInternalName

void setInternalName(String name)

setAlternativeName

void setAlternativeName(String name)

setNbrDBCSCharacters

void setNbrDBCSCharacters(int nbr)

setNullValuesAllowed

void setNullValuesAllowed(boolean allowed)

setHasHostVariable

void setHasHostVariable(boolean has)

setDateTimeFormat

void setDateTimeFormat(String format)

setDateTimeSeparator

void setDateTimeSeparator(char separator)

setIsVariableLength

void setIsVariableLength(boolean is)

setDescriptionCCSID

void setDescriptionCCSID(int ccsid)

setDataCCSID

void setDataCCSID(int ccsid)

setColumnHeadingCCSID

void setColumnHeadingCCSID(int ccsid)

setEditWordCCSID

void setEditWordCCSID(int ccsid)

setUCS2DisplayedLength

void setUCS2DisplayedLength(int len)

setDataEncodingScheme

void setDataEncodingScheme(int scheme)

setMaxLargeObjectLength

void setMaxLargeObjectLength(int len)

setLargeObjectPadLength

void setLargeObjectPadLength(int len)

setUserDefinedTypeName

void setUserDefinedTypeName(String name)

setUserDefinedTypeLibrary

void setUserDefinedTypeLibrary(String library)

setHasDatalinkControl

void setHasDatalinkControl(boolean has)

setDatalinkIntegrity

void setDatalinkIntegrity(char integrity)

setDatalinkReadPermission

void setDatalinkReadPermission(char permission)

setDatalinkWritePermission

void setDatalinkWritePermission(char permission)

setHasDatalinkRecovery

void setHasDatalinkRecovery(boolean has)

setDatalinkUnlinkAction

void setDatalinkUnlinkAction(char action)

setDefaultValue

void setDefaultValue(Object value)

getDataType

char getDataType()

Get the field's data type. Valid types are:

• A Alphanumeric (character)
• B Binary
• D Digits only
• E Either DBCS or alphanumeric
• F Floating point
• G Graphic data type
• H Hexadecimal
• I Inhibit entry
• J Double-byte character set (DBCS) data only
• L Date
• M Numeric only
• N Numeric shift
• O (Open) Both DBCS and alphanumeric
• P Packed decimal
• S Zoned decimal
• T Time
• W Katakana
• X Alphabetic only (character)
• Y Numeric only
• Z Timestamp
• 1 Binary large object (BLOB)
• 2 Character large object (CLOB)
• 3 Graphic data large object (DBCLOB)
• 4 Datalink

getUse

char getUse()

Get the field's usage. Value is one of:

• I Input
• O Output
• B Both input and output
• N Neither

getOutputBufferPosition

int getOutputBufferPosition()

getInputBufferPosition

int getInputBufferPosition()

getBufferLength

int getBufferLength()

getLength

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().

getDigits

int getDigits()

For numeric fields, returns the total length including decimals

getDecimalPosition

int getDecimalPosition()

isDoublePrecision

boolean isDoublePrecision()

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

getDescription

String getDescription()

getEditCode

String getEditCode()

getEditWord

String getEditWord()

getColumnHeading1

String getColumnHeading1()

getColumnHeading2

String getColumnHeading2()

getColumnHeading3

String getColumnHeading3()

getInternalName

String getInternalName()

getAlternativeName

String getAlternativeName()

getNbrDBCSCharacters

int getNbrDBCSCharacters()

getNullValuesAllowed

boolean getNullValuesAllowed()

getHasHostVariable

boolean getHasHostVariable()

getDateTimeFormat

String getDateTimeFormat()

getDateTimeSeparator

char getDateTimeSeparator()

getIsVariableLength

boolean getIsVariableLength()

getDescriptionCCSID

int getDescriptionCCSID()

getDataCCSID

int getDataCCSID()

getColumnHeadingCCSID

int getColumnHeadingCCSID()

getEditWordCCSID

int getEditWordCCSID()

getUCS2DisplayedLength

int getUCS2DisplayedLength()

getDataEncodingScheme

int getDataEncodingScheme()

getMaxLargeObjectLength

int getMaxLargeObjectLength()

getLargeObjectPadLength

int getLargeObjectPadLength()

getUserDefinedTypeName

String getUserDefinedTypeName()

getUserDefinedTypeLibrary

String getUserDefinedTypeLibrary()

getHasDatalinkControl

boolean getHasDatalinkControl()

getDatalinkIntegrity

char getDatalinkIntegrity()

getDatalinkReadPermission

char getDatalinkReadPermission()

getDatalinkWritePermission

char getDatalinkWritePermission()

getHasDatalinkRecovery

boolean getHasDatalinkRecovery()

getDatalinkUnlinkAction

char getDatalinkUnlinkAction()

getDefaultValue

Object getDefaultValue()