Package com.softwaremining.cics.wrappers

Interface IBMSField

All Known Implementing Classes:

BMSBlankInteger, BMSDouble, BMSGroup, BMSInteger, BMSLong, BMSString

public interface IBMSField

Method Summary

Modifier and Type	Method	Description
int	getLengthTyped()	returns the length of characters typed in front end.
boolean	isErased()	Checks if the attribute field has modified (MDT) value.
boolean	isErased2()	Checks if the attribute field has LOW-VALUES
boolean	isInputAvailable()	Checks if the number of characters typed by user is greater than 0.
boolean	isInputValid()	checks if the length-field is -1
boolean	isModified()	indicates if the user has typed in any values in the GUI front-End.
void	resetAttributes()	Assigns LOW-VALUES to attribute field
void	setColor(String newColour)	For Output Fields COLOR Field is only provided when BMS EXTATT=yes is specified on the original application (rare)
IBMSField	setFocus()	Set focus on the field
IBMSField	setIntensity(int intensity)	changes intensity from default BMSField.INTENSITY_NORMAL to BMSField.INTENSITY_DARK or BMSField.INTENSITY_BRIGHT.
void	setLengthTyped(int newLen)	Resets the length attrib fields to new value
IBMSField	setModified(boolean modified)	Sets the isModified flag on outgoing field.
IBMSField	setNumeric(boolean numeric)	Only numeric characters may be entered for the field (on the front end)
IBMSField	setProtected(boolean protect)	data may not be entered into protected fields on the front end.
IBMSField	setSkip(boolean skip)	This is equivalent of DISABLING an input field.

Method Details

setIntensity

IBMSField setIntensity(int intensity)

changes intensity from default BMSField.INTENSITY_NORMAL to BMSField.INTENSITY_DARK or BMSField.INTENSITY_BRIGHT.

setNumeric

IBMSField setNumeric(boolean numeric)

Only numeric characters may be entered for the field (on the front end)

setProtected

IBMSField setProtected(boolean protect)

data may not be entered into protected fields on the front end.

setSkip

IBMSField setSkip(boolean skip)

This is equivalent of DISABLING an input field. The cursor will not stop at fields marked as SKIP

setModified

IBMSField setModified(boolean modified)

Sets the isModified flag on outgoing field. (value of field.isModifiedByFrontEnd() will not have been changed) CICS RECEIVE will only report values which have been altered since previous SEND. E.g. after a Receive statement, bufferI.xyzI will contain NULL values if the on-screen value of XYZ is not changed between SEND and RECEIVE. using bufferI.ObjectxyzI.SetModified(true) will ensure the ON-SCREEN value is returned irrespective of whether it had been modified or not.

Parameters:

modified -

Returns:

setFocus

IBMSField setFocus()

Set focus on the field

isModified

boolean isModified()

indicates if the user has typed in any values in the GUI front-End.
Checks if the number of characters typed by user is greater than 0. ie if L-Field has greater than 0 characters.

isInputAvailable

boolean isInputAvailable()

Checks if the number of characters typed by user is greater than 0.
ie if L-Field has greater than 0 characters.

Returns:

isErased

boolean isErased()

Checks if the attribute field has modified (MDT) value.

Returns:

isErased2

boolean isErased2()

Checks if the attribute field has LOW-VALUES

resetAttributes

void resetAttributes()

Assigns LOW-VALUES to attribute field

getLengthTyped

int getLengthTyped()

returns the length of characters typed in front end. E.g. if the field has been defined as 20 chars, but user has only typed "ABC" - then value 3 will be returned.

setLengthTyped

void setLengthTyped(int newLen)

Resets the length attrib fields to new value

isInputValid

boolean isInputValid()

checks if the length-field is -1

Returns:

setColor

void setColor(String newColour)

For Output Fields COLOR Field is only provided when BMS EXTATT=yes is specified on the original application (rare)

Parameters:

newColour -