Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.services.qsys.objects
Class QSYSHostDatabaseField

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
                  extended by com.ibm.etools.iseries.comm.interfaces.ISeriesHostDatabaseField
                      extended by com.ibm.etools.iseries.services.qsys.objects.QSYSHostDatabaseField
All Implemented Interfaces:
IDataBaseFieldConstants, IISeriesHostDatabaseField, IISeriesHostFieldBasic, IISeriesHostFieldConstants, IISeriesHostFieldNameOnly, IISeriesHostObjectNameOnly, IISeriesHostRecordNameOnly, IQSYSDatabaseField, IQSYSFileField
Direct Known Subclasses:
QSYSRemoteDatabaseField

public class QSYSHostDatabaseField
extends ISeriesHostDatabaseField
implements IQSYSDatabaseField

Class that represents a database field.


Field Summary
static String copyright
           
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostDatabaseField
Copyright
 
Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldBasic
alternativeName, dataCCSID, datatype, decPos, dftValue, digits, dlControl, dlIntegrity, dlReadPermission, dlRecovery, dlUnlinkAction, dlWritePermission, dtFormat, dtSep, edtcde, edtwrd, edtwrdCCSID, hasHostVariable, hdg1, hdg2, hdg3, hdgCCSID, inputBufferPos, internalName, length, maxLOBlen, maxLOBpadlen, nbrDBCSchars, nullValuesAllowed, outputBufferPos, text, textCCSID, ucs2Len, udtLib, udtName, use, 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.IISeriesHostDatabaseField
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
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IDataBaseFieldConstants
FLDTYPE_ALPHA, FLDTYPE_BINARY, FLDTYPE_DATE, FLDTYPE_DBCS, FLDTYPE_FLOAT, FLDTYPE_FLOATD, FLDTYPE_GRAPHIC, FLDTYPE_HEX, FLDTYPE_MAX, FLDTYPE_PACKED, FLDTYPE_PUREDBCS, FLDTYPE_TIME, FLDTYPE_TIMESTAMP, FLDTYPE_UNKNOWN, FLDTYPE_VALPHA, FLDTYPE_VDBCS, FLDTYPE_VGRAPHIC, FLDTYPE_ZONED
 
Constructor Summary
QSYSHostDatabaseField()
           
 
Method Summary
 boolean equals(Object obj)
          Two QSYSHostFileField objects are equal if they have the same name, record, file, and library.
 String getAbsoluteName()
          Get the absolute name for the record
 IQSYSFileRecordFormat getParent()
          Return the parent of this object
 boolean isNumeric()
          Returns true if the field is a numeric data type
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostDatabaseField
addKeyword, getAllocatedLength, getDerivedOperator, getDisplayLength, getDTFlags, getEditCodeSymbol, getEncodingScheme, getKeywords, getReferencedField, getReferenceShift, getSubstringEnd, getSubstringStart, isCCSIDSpecified, isConvertUCS2, isDBCSAlternateTypeField, isDBCSColumnHeadings, isDBCSTextDescription, isDBCSValidityCheckingLiterals, isDisplayLengthSpecified, isMinimumDisplayLength, setAllocatedLength, setCCSIDSpecified, setDBCSAlternateTypeField, setDBCSColumnHeadings, setDBCSTextDescription, setDBCSValidityCheckingLiterals, setDerivedOperator, setDisplayLength, setDTFlags, setEditCodeSymbol, setEncodingScheme, setIsConvertUCS2, setIsDisplayLengthSpecified, setIsMinimumDisplayLength, setReferencedField, setReferenceShift, setSubstringEnd, setSubstringStart, toString
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldBasic
getAlternativeName, getBufferLength, getColumnHeading1, getColumnHeading2, getColumnHeading3, getColumnHeadingCCSID, getDataCCSID, getDataEncodingScheme, getDatalinkIntegrity, getDatalinkReadPermission, getDatalinkUnlinkAction, getDatalinkWritePermission, getDataType, getDateTimeFormat, getDateTimeSeparator, getDecimalPosition, getDefaultValue, getDescription, getDescriptionCCSID, getDigits, getEditCode, getEditWord, getEditWordCCSID, getHasDatalinkControl, getHasDatalinkRecovery, getHasHostVariable, getInputBufferPosition, getInternalName, getIsVariableLength, getLargeObjectPadLength, getLength, getMaxLargeObjectLength, getNbrDBCSCharacters, getNullValuesAllowed, getOutputBufferPosition, getUCS2DisplayedLength, getUse, getUserDefinedTypeLibrary, getUserDefinedTypeName, isDoublePrecision, setAlternativeName, setBufferLength, setColumnHeading1, setColumnHeading2, setColumnHeading3, setColumnHeadingCCSID, setDataCCSID, setDataEncodingScheme, setDatalinkIntegrity, setDatalinkReadPermission, setDatalinkUnlinkAction, setDatalinkWritePermission, setDataType, setDateTimeFormat, setDateTimeSeparator, setDecimalPosition, setDefaultValue, setDescription, setDescriptionCCSID, setDigits, setEditCode, setEditWord, setEditWordCCSID, setHasDatalinkControl, setHasDatalinkRecovery, setHasHostVariable, setInputBufferPosition, setInternalName, setIsVariableLength, setLargeObjectPadLength, setMaxLargeObjectLength, setNbrDBCSCharacters, setNullValuesAllowed, setOutputBufferPosition, setUCS2DisplayedLength, setUse, setUserDefinedTypeLibrary, setUserDefinedTypeName, writeObjectInfo
 
Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostFieldNameOnly
getRecord, setRecord
 
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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField
addKeyword, getAllocatedLength, getDerivedOperator, getDisplayLength, getDTFlags, getEditCodeSymbol, getEncodingScheme, getKeywords, getLength, getReferencedField, getReferenceShift, getSubstringEnd, getSubstringStart, isCCSIDSpecified, isConvertUCS2, isDBCSAlternateTypeField, isDBCSColumnHeadings, isDBCSTextDescription, isDBCSValidityCheckingLiterals, isDisplayLengthSpecified, isMinimumDisplayLength, setAllocatedLength, setCCSIDSpecified, setDBCSAlternateTypeField, setDBCSColumnHeadings, setDBCSTextDescription, setDBCSValidityCheckingLiterals, setDerivedOperator, setDisplayLength, setDTFlags, setEditCodeSymbol, setEncodingScheme, setIsConvertUCS2, setIsDisplayLengthSpecified, setIsMinimumDisplayLength, setReferencedField, setReferenceShift, setSubstringEnd, setSubstringStart
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostFieldBasic
getAlternativeName, getBufferLength, getColumnHeading1, getColumnHeading2, getColumnHeading3, getColumnHeadingCCSID, getDataCCSID, getDataEncodingScheme, getDatalinkIntegrity, getDatalinkReadPermission, getDatalinkUnlinkAction, getDatalinkWritePermission, getDataType, getDateTimeFormat, getDateTimeSeparator, getDecimalPosition, getDefaultValue, getDescription, getDescriptionCCSID, getDigits, getEditCode, getEditWord, getEditWordCCSID, getHasDatalinkControl, getHasDatalinkRecovery, getHasHostVariable, getInputBufferPosition, getInternalName, getIsVariableLength, getLargeObjectPadLength, getMaxLargeObjectLength, getNbrDBCSCharacters, getNullValuesAllowed, getOutputBufferPosition, getUCS2DisplayedLength, getUse, getUserDefinedTypeLibrary, getUserDefinedTypeName, isDoublePrecision, setAlternativeName, setBufferLength, setColumnHeading1, setColumnHeading2, setColumnHeading3, setColumnHeadingCCSID, setDataCCSID, setDataEncodingScheme, setDatalinkIntegrity, setDatalinkReadPermission, setDatalinkUnlinkAction, setDatalinkWritePermission, setDataType, setDateTimeFormat, setDateTimeSeparator, setDecimalPosition, setDefaultValue, setDescription, setDescriptionCCSID, setDigits, setEditCode, setEditWord, setEditWordCCSID, setHasDatalinkControl, setHasDatalinkRecovery, setHasHostVariable, setInputBufferPosition, setInternalName, setIsVariableLength, setLargeObjectPadLength, setMaxLargeObjectLength, setNbrDBCSCharacters, setNullValuesAllowed, setOutputBufferPosition, setUCS2DisplayedLength, setUse, setUserDefinedTypeLibrary, setUserDefinedTypeName
 
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

public static String copyright
Constructor Detail

QSYSHostDatabaseField

public QSYSHostDatabaseField()
Method Detail

equals

public boolean equals(Object obj)
Two QSYSHostFileField objects are equal if they have the same name, record, file, and library.

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

getParent

public IQSYSFileRecordFormat getParent()
                                throws SystemMessageException,
                                       InterruptedException
Description copied from interface: IQSYSFileField
Return the parent of this object

Specified by:
getParent in interface IQSYSFileField
Throws:
SystemMessageException
InterruptedException

getAbsoluteName

public String getAbsoluteName()
Description copied from interface: IQSYSFileField
Get the absolute name for the record

Specified by:
getAbsoluteName in interface IQSYSFileField

isNumeric

public boolean isNumeric()
Description copied from interface: IQSYSFileField
Returns true if the field is a numeric data type

Specified by:
isNumeric in interface IQSYSFileField

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.