com.attachmate.cicsbridge.j2ee.outputs
Class AllFieldInformation

java.lang.Object
  com.attachmate.cicsbridge.j2ee.outputs.AllFieldInformation

All Implemented Interfaces:

java.io.Serializable

public final class AllFieldInformation

extends java.lang.Object

implements java.io.Serializable

Return object that holds return code and field information for current screen.

See Also:

BridgeAPI_EJB.getAllFieldInformation(int, boolean), BridgeAPI_EJB.getAllFieldInformation(String, boolean), BridgeAPI_EJB.sendKeysGetAllFieldInformation(String), Serialized Form

Constructor Summary

AllFieldInformation(int returnCode, int fieldCount, java.lang.Object fieldNames, java.lang.Object fieldValues, java.lang.Object fieldAttributes, java.lang.Object fieldRows, java.lang.Object fieldCols, java.lang.Object fieldLengths)
Creates a AllFieldInformation object and sets member variables.

AllFieldInformation(int returnCode, int fieldCount, java.lang.Object fieldNames, java.lang.Object fieldValues, java.lang.Object fieldAttributes, java.lang.Object fieldRows, java.lang.Object fieldCols, java.lang.Object fieldLengths, java.lang.Object fieldColors, java.lang.Object fieldHighlights)
Creates a AllFieldInformation object and sets member variables.

Method Summary

java.lang.Object	getFieldAttributes() Returns the field attributes of all the fields on the current screen.
java.lang.Object	getFieldColors() Returns the field colors in use in the fields on the current screen.
java.lang.Object	getFieldCols() Returns the coordinates of columns of all the fields on the current screen.
int	getFieldCount() Returns the total number of fields on the current screen.
java.lang.Object	getFieldHighlights() Returns the field highlighting in use in the fields on the current screen.
java.lang.Object	getFieldLengths() Returns the lengths of all the fields on the current screen.
java.lang.Object	getFieldNames() Returns the field names of all the fields on the current screen.
java.lang.Object	getFieldRows() Returns the coordinates of rows of all the fields on the current screen.
java.lang.Object	getFieldValues() Returns the field values of all the fields on the current screen.
int	getReturnCode() Returns zero for success.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AllFieldInformation

public AllFieldInformation(int returnCode,
                           int fieldCount,
                           java.lang.Object fieldNames,
                           java.lang.Object fieldValues,
                           java.lang.Object fieldAttributes,
                           java.lang.Object fieldRows,
                           java.lang.Object fieldCols,
                           java.lang.Object fieldLengths)

Creates a AllFieldInformation object and sets member variables.

Parameters:

returnCode - - zero for success. For possible failure values, see the getReturnCodeMessage method.

fieldCount - - The total number of fields on the current screen.

fieldNames - - The field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.

fieldValues - - The field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.

fieldAttributes - - The field attributes of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field attribute.

fieldRows - - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.

fieldCols - - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.

fieldLengths - - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.

AllFieldInformation

public AllFieldInformation(int returnCode,
                           int fieldCount,
                           java.lang.Object fieldNames,
                           java.lang.Object fieldValues,
                           java.lang.Object fieldAttributes,
                           java.lang.Object fieldRows,
                           java.lang.Object fieldCols,
                           java.lang.Object fieldLengths,
                           java.lang.Object fieldColors,
                           java.lang.Object fieldHighlights)

Creates a AllFieldInformation object and sets member variables.

Parameters:

returnCode - - zero for success. For possible failure values, see the getReturnCodeMessage method.

fieldCount - - The total number of fields on the current screen.

fieldNames - - The field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.

fieldValues - - The field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.

fieldAttributes - - The field attributes of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field attribute.

fieldRows - - The coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.

fieldCols - - The coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.

fieldLengths - - The lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.

fieldColors - - The field colors in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the color:

  0    :  White
  1    :  Blue
  2    :  Red
  3    :  Pink
  4    :  Green
  5    :  Turquoise
  6    :  Yellow
  7    :  White
 

fieldHighlights - - The field highlighting in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the highlighting currently displayed for the respective 3270 field:

  0    :  Normal
  1    :  Blinking
  2    :  Reversed video
  3    :  Underscore
 

Method Detail

getReturnCode

public int getReturnCode()

Returns zero for success. For possible failure values, see the getReturnCodeMessage method.

Returns:

int value

getFieldCount

public int getFieldCount()

Returns the total number of fields on the current screen.

Returns:

int value.

getFieldNames

public java.lang.Object getFieldNames()

Returns the field names of all the fields on the current screen. Returns an array of type String, each holds a String representing the field name.

Returns:

array of type String

getFieldValues

public java.lang.Object getFieldValues()

Returns the field values of all the fields on the current screen. Returns an array of type String, each occurrence of which holds a String representing the field name.

Returns:

array of type String

getFieldAttributes

public java.lang.Object getFieldAttributes()

Returns the field attributes of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field attribute.

Returns:

An int value.

getFieldRows

public java.lang.Object getFieldRows()

Returns the coordinates of rows of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the row coordinate.

Returns:

array of type int

getFieldCols

public java.lang.Object getFieldCols()

Returns the coordinates of columns of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the column coordinate.

Returns:

array of type int

getFieldLengths

public java.lang.Object getFieldLengths()

Returns the lengths of all the fields on the current screen. Returns an array of type int, each occurrence of which holds an int for the field length.

Returns:

array of type int

getFieldColors

public java.lang.Object getFieldColors()

Returns the field colors in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the color:

  0    :  White
  1    :  Blue
  2    :  Red
  3    :  Pink
  4    :  Green
  5    :  Turquoise
  6    :  Yellow
  7    :  White
 

Returns:

array of type int

getFieldHighlights

public java.lang.Object getFieldHighlights()

Returns the field highlighting in use in the fields on the current screen. Returns an array of type int, each occurrence of which holds a value that represents the highlighting currently displayed for the respective 3270 field:

  0    :  Normal
  1    :  Blinking
  2    :  Reversed video
  3    :  Underscore
 

Returns:

array of type int