All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.CharacterFieldDescription

java.lang.Object
   |
   +----com.ibm.as400.access.FieldDescription
           |
           +----com.ibm.as400.access.CharacterFieldDescription

public class CharacterFieldDescription
extends FieldDescription
implements VariableLengthFieldDescription, Serializable
The CharacterFieldDescription class represents the description of the data in a character field. It allows: Examples


Constructor Index

 o CharacterFieldDescription()
Constructs a CharacterFieldDescription object.
 o CharacterFieldDescription(AS400Text, String)
Constructs a CharacterFieldDescription object.
 o CharacterFieldDescription(AS400Text, String, String)
Constructs a CharacterFieldDescription object.

Method Index

 o getCCSID()
Returns the value specified for the CCSID keyword for this field.
 o getVARLEN()
Returns the value specified for the VARLEN keyword for this field.
 o isVariableLength()
Indicates if the field is a variable-length field.
 o setCCSID(String)
Sets the value for the CCSID keyword for this field.
 o setDataType(AS400Text)
Sets the AS400DataType object describing this field.
 o setDFT(String)
Sets the value for the DFT keyword for this field.
 o setVariableLength(boolean)
Sets the value that indicates if the field is a variable length field.
 o setVARLEN(int)
Sets the value to specify for the VARLEN keyword for this field.

Constructors

 o CharacterFieldDescription
 public CharacterFieldDescription()
Constructs a CharacterFieldDescription object.

 o CharacterFieldDescription
 public CharacterFieldDescription(AS400Text dataType,
                                  String name)
Constructs a CharacterFieldDescription object. It uses the specified data type and name of the field. The length of the field will be the length specified on the AS400Text object.

Parameters:
dataType - Describes the field and provides the conversion capability for the contents of the field.
name - The name of the field.
 o CharacterFieldDescription
 public CharacterFieldDescription(AS400Text dataType,
                                  String name,
                                  String ddsName)
Constructs a CharacterFieldDescription object. It uses the specified data type of the field, name, and DDS name. The length of the field will be the length specified on the AS400Text object.

Parameters:
dataType - Describes the field and provides the conversion capability for the contents of the field.
name - The name of the field.
ddsName - The DDS name of this field. This is the name of the field as it would appear in a DDS description of the field. The length of ddsName must be 10 characters or less.

Methods

 o getCCSID
 public String getCCSID()
Returns the value specified for the CCSID keyword for this field.

Returns:
The value specified for the CCSID keyword for this field. If CCSID was not specified for this field, an empty string is returned.
 o getVARLEN
 public int getVARLEN()
Returns the value specified for the VARLEN keyword for this field.

Returns:
The value specified for VARLEN for this field. If VARLEN was not specified for this field, 0 is returned.
 o isVariableLength
 public boolean isVariableLength()
Indicates if the field is a variable-length field.

Returns:
true if the field is a variable-length field; false otherwise.
 o setCCSID
 public void setCCSID(String ccsid)
Sets the value for the CCSID keyword for this field.

Parameters:
ccsid - The value for the CCSID keyword for this field.
 o setDataType
 public void setDataType(AS400Text dataType)
Sets the AS400DataType object describing this field.

Parameters:
dataType - The AS400DataType that describes this field. The dataType cannot be null.
 o setDFT
 public void setDFT(String defaultValue)
Sets the value for the DFT keyword for this field.

Parameters:
defaultValue - The default value for this field. The defaultValue cannot be null.
 o setVariableLength
 public void setVariableLength(boolean value)
Sets the value that indicates if the field is a variable length field.

Parameters:
value - true if the field is a variable length field; false otherwise.
 o setVARLEN
 public void setVARLEN(int varLen)
Sets the value to specify for the VARLEN keyword for this field.

Parameters:
varLen - The value to specify for the VARLEN keyword for this field. The varLen cannot be less than zero.

All Packages  Class Hierarchy  This Package  Previous  Next  Index