Rational Developer for Power Systems Software
V7.6

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

All Superinterfaces:
IISeriesHostFieldBasic, IISeriesHostFieldConstants, IISeriesHostFieldNameOnly, IISeriesHostObjectNameOnly, IISeriesHostRecordNameOnly
All Known Subinterfaces:
IQSYSDatabaseField
All Known Implementing Classes:
ISeriesHostDatabaseField, QSYSHostDatabaseField, QSYSRemoteDatabaseField

public interface IISeriesHostDatabaseField
extends IISeriesHostFieldBasic

This interface represents a single field in a *FILE PF_DTA object (database file) on the iSeries.


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
 void addKeyword(String name, String[] parameters)
          Add a keyword to the list of keywords stored for this field.
 int getAllocatedLength()
          Get the number of bytes allocated for the field in the fixed portion of the file
 byte getDerivedOperator()
          Derived Operator (for logical fiel fields)
 int getDisplayLength()
          Get the display length.
 int getDTFlags()
          Date Time flags
 char getEditCodeSymbol()
          Get the edit code specified for this field.
 int getEncodingScheme()
          Sets the encoding scheme for this field.
 Collection getKeywords()
          Get the keywords specified for this field.
 int getLength()
          Get the length of this field.
 String getReferencedField()
          Referenced field (for logical file fields)
 char getReferenceShift()
          Get the reference shift for this field.
 int getSubstringEnd()
          Substring keyword ending position
 int getSubstringStart()
          Substring keyword starting position
 boolean isCCSIDSpecified()
          Check if the CCSID keyword was specified for this field.
 boolean isConvertUCS2()
          Get whether or not to convert UCS2 characters before printing.
 boolean isDBCSAlternateTypeField()
          Check if this field's alternate type contains DBCS data.
 boolean isDBCSColumnHeadings()
          Check if this field's column headings contain DBCS data
 boolean isDBCSTextDescription()
          Check if this field's text description contains DBCS data.
 boolean isDBCSValidityCheckingLiterals()
          Check if this field's validity checking literals (COMP, RANE, VALUES) contain DBCS data.
 boolean isDisplayLengthSpecified()
          When referenced by a display file, if true then the DDS for the field provided the allowed number of display positions as returned by getDisplayLength() This method is only supported on i5/OS V5R4 and higher.
 boolean isMinimumDisplayLength()
          When referenced by a display file, if true then getDisplayLength() contains the number of display positions allowed (and is equal to the field length defined in the DDS.) This method is only supported on i5/OS V5R4 and higher.
 void setAllocatedLength(int length)
          Set the allocated length for this field.
 void setCCSIDSpecified(boolean ccsidSpecified)
          Set whether or not the CCSID keyword was specified for this field.
 void setDBCSAlternateTypeField(boolean flag)
          Set whether this field's alternate type contains DBCS data
 void setDBCSColumnHeadings(boolean flag)
          Set whether this field's column headings contain DBCS data
 void setDBCSTextDescription(boolean flag)
          Set whether this field's text description contains DBCS data
 void setDBCSValidityCheckingLiterals(boolean flag)
          Set whether this field's validity checking literals (COMP, RANGE, VALUES) contain DBCS data.
 void setDerivedOperator(byte operator)
          Derived Operator (for logical file fields)
 void setDisplayLength(int length)
          Set the display length.
 void setDTFlags(int flags)
          Date Time Flags
 void setEditCodeSymbol(char symbol)
          Set the edit code symbol for this field.
 void setEncodingScheme(int encodingScheme)
          Sets the encoding scheme for this field.
 void setIsConvertUCS2(boolean convert)
          Set whether or not to convert UCS2 characters before printing.
 void setIsDisplayLengthSpecified(boolean value)
          When referenced by a display file, if true then the DDS for the field provided the allowed number of display positions as returned by getDisplayLength() This method is only supported on i5/OS V5R4 and higher.
 void setIsMinimumDisplayLength(boolean value)
          When referenced by a display file, if true then getDisplayLength() contains the number of display positions allowed (and is equal to the field length defined in the DDS.) This method is only supported on i5/OS V5R4 and higher.
 void setReferencedField(String referencedField)
          Referenced field (for logical file fields)
 void setReferenceShift(char referenceShift)
          Set the reference shift for this field.
 void setSubstringEnd(int end)
          Substring keyword ending position
 void setSubstringStart(int start)
          Substring keyword starting position
 
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

static final String Copyright
See Also:
Constant Field Values
Method Detail

getAllocatedLength

int getAllocatedLength()
Get the number of bytes allocated for the field in the fixed portion of the file


isCCSIDSpecified

boolean isCCSIDSpecified()
Check if the CCSID keyword was specified for this field.


getReferenceShift

char getReferenceShift()
Get the reference shift for this field.


getLength

int getLength()
Get the length of this field.

Specified by:
getLength in interface IISeriesHostFieldBasic

getKeywords

Collection getKeywords()
Get the keywords specified for this field.

Returns:
A collection of IISeriesHostFieldKeyword instances, each representing a keyword and it's parameters.
See Also:
IISeriesHostFieldKeyword

getEditCodeSymbol

char getEditCodeSymbol()
Get the edit code specified for this field.


isDBCSAlternateTypeField

boolean isDBCSAlternateTypeField()
Check if this field's alternate type contains DBCS data.


isDBCSTextDescription

boolean isDBCSTextDescription()
Check if this field's text description contains DBCS data.


isDBCSColumnHeadings

boolean isDBCSColumnHeadings()
Check if this field's column headings contain DBCS data


isDBCSValidityCheckingLiterals

boolean isDBCSValidityCheckingLiterals()
Check if this field's validity checking literals (COMP, RANE, VALUES) contain DBCS data.


getSubstringStart

int getSubstringStart()
Substring keyword starting position


getSubstringEnd

int getSubstringEnd()
Substring keyword ending position


getReferencedField

String getReferencedField()
Referenced field (for logical file fields)


getDerivedOperator

byte getDerivedOperator()
Derived Operator (for logical fiel fields)


getDTFlags

int getDTFlags()
Date Time flags


getDisplayLength

int getDisplayLength()
Get the display length. When referenced by a display field, this value represents the number of display positions allowed. This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

isConvertUCS2

boolean isConvertUCS2()
Get whether or not to convert UCS2 characters before printing. When referenced by a printer file, indicates whether UCS2 characters are to be converted before printing. If true then convert. This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

isMinimumDisplayLength

boolean isMinimumDisplayLength()
When referenced by a display file, if true then getDisplayLength() contains the number of display positions allowed (and is equal to the field length defined in the DDS.) This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

isDisplayLengthSpecified

boolean isDisplayLengthSpecified()
When referenced by a display file, if true then the DDS for the field provided the allowed number of display positions as returned by getDisplayLength() This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

getEncodingScheme

int getEncodingScheme()
Sets the encoding scheme for this field. A value of 0 means there is no encoding scheme set. This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

setAllocatedLength

void setAllocatedLength(int length)
Set the allocated length for this field.


setCCSIDSpecified

void setCCSIDSpecified(boolean ccsidSpecified)
Set whether or not the CCSID keyword was specified for this field.


setReferenceShift

void setReferenceShift(char referenceShift)
Set the reference shift for this field.


addKeyword

void addKeyword(String name,
                String[] parameters)
Add a keyword to the list of keywords stored for this field.


setEditCodeSymbol

void setEditCodeSymbol(char symbol)
Set the edit code symbol for this field.


setDBCSAlternateTypeField

void setDBCSAlternateTypeField(boolean flag)
Set whether this field's alternate type contains DBCS data


setDBCSTextDescription

void setDBCSTextDescription(boolean flag)
Set whether this field's text description contains DBCS data


setDBCSColumnHeadings

void setDBCSColumnHeadings(boolean flag)
Set whether this field's column headings contain DBCS data


setDBCSValidityCheckingLiterals

void setDBCSValidityCheckingLiterals(boolean flag)
Set whether this field's validity checking literals (COMP, RANGE, VALUES) contain DBCS data.


setSubstringStart

void setSubstringStart(int start)
Substring keyword starting position


setSubstringEnd

void setSubstringEnd(int end)
Substring keyword ending position


setReferencedField

void setReferencedField(String referencedField)
Referenced field (for logical file fields)


setDerivedOperator

void setDerivedOperator(byte operator)
Derived Operator (for logical file fields)


setDTFlags

void setDTFlags(int flags)
Date Time Flags


setDisplayLength

void setDisplayLength(int length)
Set the display length. When referenced by a display field, this value represents the number of display positions allowed. This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

setIsConvertUCS2

void setIsConvertUCS2(boolean convert)
Set whether or not to convert UCS2 characters before printing. When referenced by a printer file, indicates whether UCS2 characters are to be converted before printing. If true then convert. This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

setIsMinimumDisplayLength

void setIsMinimumDisplayLength(boolean value)
When referenced by a display file, if true then getDisplayLength() contains the number of display positions allowed (and is equal to the field length defined in the DDS.) This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

setIsDisplayLengthSpecified

void setIsDisplayLengthSpecified(boolean value)
When referenced by a display file, if true then the DDS for the field provided the allowed number of display positions as returned by getDisplayLength() This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

setEncodingScheme

void setEncodingScheme(int encodingScheme)
Sets the encoding scheme for this field. A value of 0 means there is no encoding scheme set. This method is only supported on i5/OS V5R4 and higher.

Since:
RWDi 6.0

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.