UI record bean API

At run time, the VGUIRecord part is represented by a UI record bean. The commands listed in the interface below can access this bean from a JSP file.

The String class is used by all get and set methods implemented for variables with a uiType property of input, output, or inputOutput in the Java™ Bean generated for the UI record.

Set and get methods implemented for variables that are defined with a uiType of none return the appropriate Java class for the variable.

UI Record Bean Interface

The get and set methods implemented for the UI record bean are described in this section. These methods get and change information about the VGUIRecord as a whole.

String getTitle();
Returns the default title of the page from the title property of the VGUIRecord.
String getHelpText();
Returns the text from the help property of the VGUIRecord.
String getGatewayURL();
Returns the gateway URL and is used as the ACTION of an HTML form.
String getSecureGatewayURL();
Returns the gateway URL with the HTTPS protocol and is used as the ACTION of an HTML form.
String getPageID();
String form of the number that uniquely marks the page that is served to the client.
String getAppID();
Returns the ID that identifies the web transaction with which the VGUIRecord is associated.
String getSessionID();
Returns the ID that identifies the current gateway session that processes the submit request.
boolean hasInputError();
Indicates whether or not any field in the VGUIRecord is in error.
VGDataElement elementNamed(String name);
Returns the element in the UI record bean named name.
VGDataElement getfieldName();
Returns the value of the specified field from the VGUIRecord.
void setfieldName(String value);
Sets the specified field from the VGUIRecord to the specified value.

VGDataElement Interface

These methods get or change information about an individual field (a VGDataElement) within the VGUIRecord.

Enumeration getEditTableValues();
Returns the elements in an edit table associated with an input field.
String getErrorMessage();
Returns the error message associated with the element.
String getGatewayURL();

For variables that do not have a uiType property set to form or programLink, returns the same value as the UI record bean version of this method.

For variables that do have a uiType property set to form or programLink, returns a URL string that contains all the parameters as defined by the link properties. This string is usable as an HREF in an <A> HTML element.

String getSecureGatewayURL();
Same as getGatewayURL() but uses the HTTPS protocol.
String getHelpText();
Returns the text in the help property for the field.
int getIndex();
Returns the index of the element.
String getLabel();
Returns the label UI property of a variable. If the variable is an element of an array, returns the label defined for the index of the VGDataElement instance.
String getTextValue();
Returns the String value of the element with all output formatting on the data.
TableModel getTextValuesTable();
Returns a TableModel of all formatted text values for the occurrences and sub-elements of the VGDataElement instance.
boolean hasInputError();
Returns TRUE if the element has an input error.
boolean isDisplayable();
Returns TRUE if the variable associated with a submit button has a non-blank value.
boolean isEmpty();

Returns TRUE only when the field is an array, and the value of the field specified by the numElementsItem property is zero.

In any other case the method returns FALSE. The following cases return FALSE:
  • The field is not an array.
  • The field is an array, but the numElementsItem property has a null value.
  • The field is an array, but the value of the field specified by the numElementsItem property is not zero.
boolean isSelected();
Returns TRUE if the index of the element is a value in the field specified by the SelectedIndexItem property.
Enumeration occurrences();
If the target VGDataElement is an array, the method returns an Enumeration containing the elements of that array. The number of elements returned is limited by the value of the field in the numElementsItem property. If the target is not an array, the method returns an Enumeration with only a single element.
Enumeration subElements();
Returns Enumeration of VGDataElements that are valid sub-elements (the uiType property is not set to none) of the VGDataElement instance. Only the lowest level sub-elements are returned. The index of each sub-element is that of the VGDataElement instance.
void setDatetimeFormat(DateFormat_object);
Sets a Java DateFormat object to specify the valid format for date/time values that pass between the browser and tier 2 in either direction. You can use this method only on a variable that has been assigned a date or time edit.

Feedback