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

java.lang.Object
  com.ibm.etools.iseries.comm.interfaces.ISeriesHostKeyField

All Implemented Interfaces:

IISeriesHostKeyField

public class ISeriesHostKeyField
extends Object
implements IISeriesHostKeyField

This class 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

Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostKeyField

copyright

Constructor Summary

ISeriesHostKeyField()

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

Constructor Detail

ISeriesHostKeyField

public ISeriesHostKeyField()

Method Detail

getName

public String getName()

Description copied from interface: IISeriesHostKeyField

Get the external name

Specified by:

getName in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getName()

getInternalName

public String getInternalName()

Description copied from interface: IISeriesHostKeyField

Get the internal name

Specified by:

getInternalName in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getInternalName()

getDataType

public char getDataType()

Description copied from interface: IISeriesHostKeyField

Get the data type

Specified by:

getDataType in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getDataType()

getLength

public int getLength()

Description copied from interface: IISeriesHostKeyField

Get the field length

Specified by:

getLength in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getLength()

getDigits

public int getDigits()

Description copied from interface: IISeriesHostKeyField

Get the number of digits

Specified by:

getDigits in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getDigits()

getDecimalPositions

public int getDecimalPositions()

Description copied from interface: IISeriesHostKeyField

Get the number of decimal positions

Specified by:

getDecimalPositions in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getDecimalPositions()

getAlternateName

public String getAlternateName()

Description copied from interface: IISeriesHostKeyField

Get the alternate name (alias)

Specified by:

getAlternateName in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getAlternateName()

setName

public void setName(String name)

Description copied from interface: IISeriesHostKeyField

Set the external name

Specified by:

setName in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setName(String)

setInternalName

public void setInternalName(String name)

Description copied from interface: IISeriesHostKeyField

Set the internal name

Specified by:

setInternalName in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setInternalName(String)

setDataType

public void setDataType(char type)

Description copied from interface: IISeriesHostKeyField

Set the data type

Specified by:

setDataType in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setDataType(char)

setLength

public void setLength(int length)

Description copied from interface: IISeriesHostKeyField

Set the field length

Specified by:

setLength in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setLength(int)

setDigits

public void setDigits(int digits)

Description copied from interface: IISeriesHostKeyField

Set the number of digits

Specified by:

setDigits in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setDigits(int)

setDecimalPositions

public void setDecimalPositions(int decpos)

Description copied from interface: IISeriesHostKeyField

Set the number of decimal positions

Specified by:

setDecimalPositions in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setDecimalPositions(int)

setAlternateName

public void setAlternateName(String altName)

Description copied from interface: IISeriesHostKeyField

Set the alternate name (alias)

Specified by:

setAlternateName in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setAlternateName(String)

isVariableLength

public boolean isVariableLength()

Description copied from interface: IISeriesHostKeyField

Is this field varying length?

Specified by:

isVariableLength in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.isVariableLength()

setIsVariableLength

public void setIsVariableLength(boolean variableLength)

Description copied from interface: IISeriesHostKeyField

Set if this field is varaible length

Specified by:

setIsVariableLength in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setIsVariableLength(boolean)

getAttributes

public byte getAttributes()

Description copied from interface: IISeriesHostKeyField

Get the key field attributes

Specified by:

getAttributes in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getAttributes()

setAttributes

public void setAttributes(byte attributes)

Description copied from interface: IISeriesHostKeyField

Set the key field attributes

Specified by:

setAttributes in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setAttributes(byte)

getGenericKeyCount

public int getGenericKeyCount()

Description copied from interface: IISeriesHostKeyField

Get the file generic key count

Specified by:

getGenericKeyCount in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getGenericKeyCount()

getMaximumKeyLength

public int getMaximumKeyLength()

Description copied from interface: IISeriesHostKeyField

Get the maximum key length for any of the keys in the file.

Specified by:

getMaximumKeyLength in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.getMaximumKeyLength()

setGenericKeyCount

public void setGenericKeyCount(int count)

Description copied from interface: IISeriesHostKeyField

Set the file generic key count

Specified by:

setGenericKeyCount in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setGenericKeyCount(int)

setMaximumKeyLength

public void setMaximumKeyLength(int length)

Description copied from interface: IISeriesHostKeyField

Set the maximum key length for any of the keys in the file.

Specified by:

setMaximumKeyLength in interface IISeriesHostKeyField

See Also:

IISeriesHostKeyField.setMaximumKeyLength(int)