All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.TimeFieldDescription

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

public class TimeFieldDescription
extends FieldDescription
implements Serializable
The TimeFieldDescription class represents the description of the data in a time field. The TimeFieldDescription class allows: Examples


Constructor Index

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

Method Index

 o getTIMFMT()
Returns the value specified for the TIMFMT keyword for this field.
 o getTIMSEP()
Returns the value specified for the TIMSEP 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 setDFTCurrent()
Sets the default value for this field to be the current date.
 o setDFTNull()
Sets the value for the DFT keyword to be *NULL for this field.
 o setTIMFMT(String)
Sets the value to specify for the TIMFMT keyword for this field.
 o setTIMSEP(String)
Sets the value to specify for the TIMSEP keyword for this field.

Constructors

 o TimeFieldDescription
 public TimeFieldDescription()
Constructs a TimeFieldDescription object.

 o TimeFieldDescription
 public TimeFieldDescription(AS400Text dataType,
                             String name)
Constructs a TimeFieldDescription object. It uses the data type and name of the field specified.

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

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 getTIMFMT
 public String getTIMFMT()
Returns the value specified for the TIMFMT keyword for this field.

Returns:
The value specified for TIMFMT for this field. If TIMFMT was not specified for this field, an empty string is returned.
 o getTIMSEP
 public String getTIMSEP()
Returns the value specified for the TIMSEP keyword for this field.

Returns:
The value specified for TIMSEP for this field. If TIMSEP was not specified for this field, an empty string is returned.
 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. To set a default value of *NULL, use the setDFTNull() method.
 o setDFTCurrent
 public void setDFTCurrent()
Sets the default value for this field to be the current date. Calling this method will replace the DFT keyword that was previously set on a call to setDFT(String) or setDFTNull().

 o setDFTNull
 public void setDFTNull()
Sets the value for the DFT keyword to be *NULL for this field. Calling this method will replace the DFT keyword that was previously set on a call to setDFT(String) or setDFTCurrent(). Note: This field must also have its ALWNULL keyword set to true to prevent DDS errors.

 o setTIMFMT
 public void setTIMFMT(String timeFormat)
Sets the value to specify for the TIMFMT keyword for this field.

Parameters:
timeFormat - The value to specify for TIMFMT for this field. The timeFormat cannot be null.
 o setTIMSEP
 public void setTIMSEP(String timeSeparator)
Sets the value to specify for the TIMSEP keyword for this field.

Parameters:
timeSeparator - The value to specify for TIMSEP for this field. The timeSeparator cannot be null.

All Packages  Class Hierarchy  This Package  Previous  Next  Index