com.wrq.apptrieve.appconn

Class FieldMetaData

java.lang.Object

com.wrq.apptrieve.appconn.FieldMetaData

All Implemented Interfaces:

AppConnMetaData

public class FieldMetaData
extends java.lang.Object
implements AppConnMetaData

Provides metadata about a field that is defined in a recordset of a Host Integrator model.

Field Summary

Fields inherited from interface com.wrq.apptrieve.appconn.AppConnMetaData

METADATA_TYPE_ATTRIBUTE, METADATA_TYPE_COLUMN, METADATA_TYPE_FIELD, METADATA_TYPE_OPERATION, METADATA_TYPE_PROCEDURE, METADATA_TYPE_RECORDSET, METADATA_TYPE_VARIABLE

Constructor Summary

Constructors

Constructor and Description
FieldMetaData(RecordsetFieldMeta saObject) Constructor for internal use only.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets the description for the field.
int	getLength() Gets the length of the field -- the total number of screen characters.
int	getMetaDataType() Gets the meta data type for this object.
java.lang.String	getName() Gets the name of the field.
boolean	isKey() Discovers whether the field is a key or part of a key for the record set.
boolean	isReadable() Discovers whether the field is readable.
boolean	isWriteable() Discovers whether the field is writeable.
boolean	terminalAttributesEnabled() Discovers whether the terminal attributes are enabled for the field.
java.lang.String	toString() Generates a String object that represents the current values of this FieldMetaData object.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldMetaData

public FieldMetaData(RecordsetFieldMeta saObject)

Constructor for internal use only.

Parameters:

saObject - data

Method Detail

getDescription

public java.lang.String getDescription()

Gets the description for the field.

Specified by:

getDescription in interface AppConnMetaData

Returns:

String the description

getLength

public int getLength()

Gets the length of the field -- the total number of screen characters. This method returns a value of -1 if the length of the field is variable.

Returns:

int the length of the field

getMetaDataType

public int getMetaDataType()

Gets the meta data type for this object.

Specified by:

getMetaDataType in interface AppConnMetaData

Returns:

int - always returns AppConnMetaData.METADATA_TYPE_FIELD

getName

public java.lang.String getName()

Gets the name of the field.

Specified by:

getName in interface AppConnMetaData

Returns:

String the field name

isKey

public boolean isKey()

Discovers whether the field is a key or part of a key for the record set. A record set key can be a single field or composed of multiple fields.

Returns:

boolean true if the field is a key

isReadable

public boolean isReadable()

Discovers whether the field is readable.

Returns:

boolean true if the field value can be read

isWriteable

public boolean isWriteable()

Discovers whether the field is writeable.

Returns:

boolean true if the field can be updated

terminalAttributesEnabled

public boolean terminalAttributesEnabled()

Discovers whether the terminal attributes are enabled for the field.

Returns:

boolean true if a TerminalAttributes object will be returned for this field when the session has set enabledTerminalAttributes(true)

toString

public java.lang.String toString()

Generates a String object that represents the current values of this FieldMetaData object.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String - the string representation of this object