com.goldencode.p2j.persist

Interface BufferField

All Superinterfaces:

ADMData, Available, CommonField, DatabaseInfo, NamedSerializable, SerializeHiddenable, Sizeable, UniqueID, WrappedResource, WriteProtectable, XmlNode

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

BufferFieldImpl

public interface BufferField
extends ADMData, Available, CommonField, DatabaseInfo, NamedSerializable, SerializeHiddenable, Sizeable, UniqueID, WrappedResource, WriteProtectable, XmlNode

Defines the public API for services representing Progress builtin functions, methods, attributes, and language statements, which operate on fields.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMBO_BOX The COMBO-BOX value for VIEW-AS attribute
static java.lang.String	DROP_DOWN The DROP-DOWN value for VIEW-AS attribute
static java.lang.String	DROP_DOWN_LIST The DROP-DOWN-LIST value for VIEW-AS attribute
static java.lang.String	FILL_IN The FILL-IN value for VIEW-AS attribute
static java.lang.String	TOGGLE_BOX The TOGGLE-BOX value for VIEW-AS attribute

Fields inherited from interface com.goldencode.p2j.persist.XmlNode

ATTRIBUTE, ELEMENT, HIDDEN, TEXT

Method Summary

Modifier and Type	Method and Description
handle	bufferHandle() Returns the handle of the buffer object to which the buffer-field belongs.
character	bufferName() Conversion of BUFFER-NAME attribute (KW_BUF_NAME).
logical	caseSensitive() Getter of CASE-SENSITIVE attribute.
void	changeLiteralQuestion(logical literalQuestion) Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN).
void	changeValidateExpression(character validateExpression) Conversion of VALIDATE-EXPRESSION attribute (KW_VAL_EXPR).
void	changeValidateMessage(character validateMessage) Conversion of VALIDATE-MESSAGE attribute (KW_VAL_MSG).
void	changeValue(int index, java.lang.Object newValue) Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
void	changeValue(NumberType index, java.lang.Object newValue) Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
void	changeValue(java.lang.Object newValue) Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
integer	extent() Conversion of EXTENT attribute (KW_EXTENT).
integer	getDecimals() Obtain the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.
character	getDefaultString() Get the DEFAULT-STRING attribute.
BaseDataType	getDefaultValue() Get the DEFAULT-VALUE attribute.
character	initial() Conversion of INITIAL attribute (KW_INIT).
logical	isKey() Checks whether this field participates in an index.
logical	literalQuestion() Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN).
logical	mandatory() Conversion of MANDATORY attribute (KW_MAND).
integer	position() Gets the read-only POSITION attribute.
void	setDecimals(long decimals) Sets the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.
void	setDecimals(NumberType decimals) Sets the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.
void	setDefaultString(character val) Set the DEFAULT-STRING attribute.
void	setDefaultString(java.lang.String val) Set the DEFAULT-STRING attribute.
character	stringValue() Conversion of STRING-VALUE attribute (KW_STR_VAL).
character	stringValue(int index) Conversion of STRING-VALUE attribute (KW_STR_VAL).
character	stringValue(NumberType index) Conversion of STRING-VALUE attribute (KW_STR_VAL).
character	validateExpression() Conversion of VALIDATE-EXPRESSION attribute (KW_VAL_EXPR).
character	validateMessage() Conversion of VALIDATE-MESSAGE attribute (KW_VAL_MSG).
BaseDataType	value() Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
BaseDataType	value(int index) Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
BaseDataType	value(NumberType index) Conversion of BUFFER-VALUE attribute (KW_BUF_VAL).
character	viewAs() Get the BUFFER:VIEW-AS attribute.
void	viewAs(character viewAs) Set the BUFFER:VIEW-AS attribute.
void	viewAs(java.lang.String viewAs) Set the BUFFER:VIEW-AS attribute.

Methods inherited from interface com.goldencode.p2j.util.ADMData

getADMData, setADMData, setADMData

Methods inherited from interface com.goldencode.p2j.util.Available

available

Methods inherited from interface com.goldencode.p2j.util.CommonField

getColumnLabel, getDataType, getFormat, getHelp, getLabel, setColumnLabel, setColumnLabel, setDataType, setDataType, setFormat, setFormat, setHelp, setHelp, setLabel, setLabel, setLabel

Methods inherited from interface com.goldencode.p2j.util.DatabaseInfo

getDbName, getTable

Methods inherited from interface com.goldencode.p2j.persist.NamedSerializable

getSerializeName, setSerializeName, setSerializeName

Methods inherited from interface com.goldencode.p2j.persist.SerializeHiddenable

getSerializeHidden, setSerializeHidden, setSerializeHidden

Methods inherited from interface com.goldencode.p2j.util.Sizeable

getHeight, getHeightChars, getHeightPixels, getWidth, getWidthChars, getWidthPixels, setHeight, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setWidth, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels

Methods inherited from interface com.goldencode.p2j.util.UniqueID

getUniqueID

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Methods inherited from interface com.goldencode.p2j.ui.WriteProtectable

isReadOnly, setReadOnly, setReadOnly

Methods inherited from interface com.goldencode.p2j.persist.XmlNode

getXmlDataType, getXmlNodeName, getXmlNodeType, setXmlDataType, setXmlDataType, setXmlNodeName, setXmlNodeName, setXmlNodeType, setXmlNodeType

Field Detail

COMBO_BOX

static final java.lang.String COMBO_BOX

The COMBO-BOX value for VIEW-AS attribute

See Also:

Constant Field Values

DROP_DOWN

static final java.lang.String DROP_DOWN

The DROP-DOWN value for VIEW-AS attribute

See Also:

Constant Field Values

DROP_DOWN_LIST

static final java.lang.String DROP_DOWN_LIST

The DROP-DOWN-LIST value for VIEW-AS attribute

See Also:

Constant Field Values

FILL_IN

static final java.lang.String FILL_IN

The FILL-IN value for VIEW-AS attribute

See Also:

Constant Field Values

TOGGLE_BOX

static final java.lang.String TOGGLE_BOX

The TOGGLE-BOX value for VIEW-AS attribute

See Also:

Constant Field Values

Method Detail

extent

integer extent()

Conversion of EXTENT attribute (KW_EXTENT). Getter of EXTENT attribute

Returns:

the value of EXTENT attribute.

stringValue

character stringValue()

Conversion of STRING-VALUE attribute (KW_STR_VAL). Getter of STRING-VALUE attribute.

Returns:

current value of STRING-VALUE attribute.

stringValue

character stringValue(int index)

Conversion of STRING-VALUE attribute (KW_STR_VAL). Getter of STRING-VALUE attribute.

Parameters:

index - An integer expression representing a subscript, for fields that have extents.

Returns:

current value of STRING-VALUE attribute.

stringValue

character stringValue(NumberType index)

Conversion of STRING-VALUE attribute (KW_STR_VAL). Getter of STRING-VALUE attribute.

Parameters:

index - An integer expression representing a subscript, for fields that have extents.

Returns:

current value of STRING-VALUE attribute.

value

BaseDataType value(int index)

Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Getter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.

Parameters:

index - An INTEGER expression representing a subscript, for fields that have extents.

Returns:

current value of a buffer-field object.

value

BaseDataType value(NumberType index)

Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Getter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.

Parameters:

index - An INTEGER expression representing a subscript, for fields that have extents.

Returns:

current value of a buffer-field object.

changeValue

void changeValue(int index,
                 java.lang.Object newValue)

Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Setter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.

Parameters:

index - An INTEGER expression representing a subscript, for fields that have extents.

newValue - New value of a buffer-field object.

changeValue

void changeValue(NumberType index,
                 java.lang.Object newValue)

Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Setter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.

Parameters:

index - An INTEGER expression representing a subscript, for fields that have extents.

newValue - New value of a buffer-field object.

value

BaseDataType value()

Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Getter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.

Returns:

current value of a buffer-field object.

changeValue

void changeValue(java.lang.Object newValue)

Conversion of BUFFER-VALUE attribute (KW_BUF_VAL). Setter of current value of a buffer-field object. If you modify the BUFFER-VALUE attribute, Progress sets the buffer-field object to the new value.

Parameters:

newValue - New value of a buffer-field object.

bufferName

character bufferName()

Conversion of BUFFER-NAME attribute (KW_BUF_NAME). Gets the name of the buffer object to which the buffer-field object belongs.

Returns:

name of the buffer object to which the buffer-field object belongs.

bufferHandle

handle bufferHandle()

Returns the handle of the buffer object to which the buffer-field belongs.

Returns:

the handle of the buffer object to which the buffer-field belongs.

initial

character initial()

Conversion of INITIAL attribute (KW_INIT). Getter of INITIAL attribute.

Returns:

Current value of INITIAL attribute.

literalQuestion

logical literalQuestion()

Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN). Getter of LITERAL-QUESTION attribute.

Returns:

current value of LITERAL-QUESTION attribute.

changeLiteralQuestion

void changeLiteralQuestion(logical literalQuestion)

Conversion of LITERAL-QUESTION attribute (KW_LIT_QSTN). Setter of LITERAL-QUESTION attribute.

Parameters:

literalQuestion - New value of LITERAL-QUESTION attribute.

validateMessage

character validateMessage()

Conversion of VALIDATE-MESSAGE attribute (KW_VAL_MSG). Getter of VALIDATE-MESSAGE attribute.

Returns:

current value of VALIDATE-MESSAGE attribute.

changeValidateMessage

void changeValidateMessage(character validateMessage)

Conversion of VALIDATE-MESSAGE attribute (KW_VAL_MSG). Setter of VALIDATE-MESSAGE attribute.

Parameters:

validateMessage - New value of VALIDATE-MESSAGE attribute.

mandatory

logical mandatory()

Conversion of MANDATORY attribute (KW_MAND). Getter of KW_MAND attribute.

Returns:

current value of KW_MAND attribute.

position

integer position()

Gets the read-only POSITION attribute.

Returns:

Current value of POSITION attribute.

validateExpression

character validateExpression()

Conversion of VALIDATE-EXPRESSION attribute (KW_VAL_EXPR). Getter of VALIDATE-EXPRESSION attribute.

Returns:

current value of VALIDATE-EXPRESSION attribute.

changeValidateExpression

void changeValidateExpression(character validateExpression)

Conversion of VALIDATE-EXPRESSION attribute (KW_VAL_EXPR). Setter of VALIDATE-EXPRESSION attribute.

Parameters:

validateExpression - New value of VALIDATE-EXPRESSION attribute.

caseSensitive

logical caseSensitive()

Getter of CASE-SENSITIVE attribute. Indicates whether the buffer-field is case-sensitive.

Returns:

current value of CASE-SENSITIVE attribute.

getDecimals

integer getDecimals()

Obtain the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.

Returns:

The number of decimals after the decimal point for this buffer-field.

setDecimals

void setDecimals(NumberType decimals)

Sets the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.

This attribute is writable for temp-tables but only read-only for permanent tables.

Parameters:

decimals - The new number of decimals after the decimal point for this buffer-field.

setDecimals

void setDecimals(long decimals)

Sets the number of decimal places, after the decimal point, that are stored in this buffer-field object that corresponds to a DECIMAL field.

This attribute is writable for temp-tables but only read-only for permanent tables.

Parameters:

decimals - The new number of decimals after the decimal point for this buffer-field.

isKey

logical isKey()

Checks whether this field participates in an index.

Returns:

true if this field is part of an index.

getDefaultValue

BaseDataType getDefaultValue()

Get the DEFAULT-VALUE attribute. This is the initial value of the field in its proper data type. This is a polymorphic return type which must be specified as a BDT value even though it will have the actual data type of the field on return.

Returns:

The default value of the field.

getDefaultString

character getDefaultString()

Get the DEFAULT-STRING attribute.

Returns:

See above.

setDefaultString

void setDefaultString(java.lang.String val)

Set the DEFAULT-STRING attribute.

Parameters:

val - The default-string value.

setDefaultString

void setDefaultString(character val)

Set the DEFAULT-STRING attribute.

Parameters:

val - The default-string value.

viewAs

character viewAs()

Get the BUFFER:VIEW-AS attribute.

Returns:

the value of BUFFER:VIEW-AS attribute.

viewAs

void viewAs(java.lang.String viewAs)

Set the BUFFER:VIEW-AS attribute.

Parameters:

viewAs - The flag state.

viewAs

void viewAs(character viewAs)

Set the BUFFER:VIEW-AS attribute.

Parameters:

viewAs - The flag state.