Rational Developer for Power Systems Software
V7.6

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

All Known Implementing Classes:
ISeriesHostKeyField

public interface IISeriesHostKeyField

This interface represents a single key field for an iSeries file record format as returned by the QDBRTVFD api using format FILD0300.

See Also:
IISeriesHostRecordFormatKeyInformation

Field Summary
static String copyright
           
 
Method Summary
 String getAlternateName()
          Get the alternate name (alias)
 byte getAttributes()
          Get the key field attributes
 char getDataType()
          Get the data type
 int getDecimalPositions()
          Get the number of decimal positions
 int getDigits()
          Get the number of digits
 int getGenericKeyCount()
          Get the file generic key count
 String getInternalName()
          Get the internal name
 int getLength()
          Get the field length
 int getMaximumKeyLength()
          Get the maximum key length for any of the keys in the file.
 String getName()
          Get the external name
 boolean isVariableLength()
          Is this field varying length?
 void setAlternateName(String altName)
          Set the alternate name (alias)
 void setAttributes(byte attributes)
          Set the key field attributes
 void setDataType(char type)
          Set the data type
 void setDecimalPositions(int decpos)
          Set the number of decimal positions
 void setDigits(int digits)
          Set the number of digits
 void setGenericKeyCount(int count)
          Set the file generic key count
 void setInternalName(String name)
          Set the internal name
 void setIsVariableLength(boolean variableLength)
          Set if this field is varaible length
 void setLength(int length)
          Set the field length
 void setMaximumKeyLength(int length)
          Set the maximum key length for any of the keys in the file.
 void setName(String name)
          Set the external name
 

Field Detail

copyright

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

getName

String getName()
Get the external name


getInternalName

String getInternalName()
Get the internal name


getDataType

char getDataType()
Get the data type


getLength

int getLength()
Get the field length


getDigits

int getDigits()
Get the number of digits


getDecimalPositions

int getDecimalPositions()
Get the number of decimal positions


getAlternateName

String getAlternateName()
Get the alternate name (alias)


isVariableLength

boolean isVariableLength()
Is this field varying length?


getAttributes

byte getAttributes()
Get the key field attributes


getMaximumKeyLength

int getMaximumKeyLength()
Get the maximum key length for any of the keys in the file.


getGenericKeyCount

int getGenericKeyCount()
Get the file generic key count


setName

void setName(String name)
Set the external name


setInternalName

void setInternalName(String name)
Set the internal name


setDataType

void setDataType(char type)
Set the data type


setLength

void setLength(int length)
Set the field length


setDigits

void setDigits(int digits)
Set the number of digits


setDecimalPositions

void setDecimalPositions(int decpos)
Set the number of decimal positions


setAlternateName

void setAlternateName(String altName)
Set the alternate name (alias)


setIsVariableLength

void setIsVariableLength(boolean variableLength)
Set if this field is varaible length


setAttributes

void setAttributes(byte attributes)
Set the key field attributes


setMaximumKeyLength

void setMaximumKeyLength(int length)
Set the maximum key length for any of the keys in the file.


setGenericKeyCount

void setGenericKeyCount(int count)
Set the file generic key count


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.