CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.connector2.cics
Interface EPIScreenRecord

All Superinterfaces:
java.lang.Cloneable, javax.resource.cci.Record, java.io.Serializable

public interface EPIScreenRecord
extends javax.resource.cci.Record

This interface represents a screen, and provides methods for querying information about the screen and for retrieving fields from the screen.


Method Summary
 EPIFieldRecord getField(int index)
          Returns a field at the given index.
 int getFieldCount()
          Returns the number of fields on the screen.
 java.util.Iterator getFields()
          This returns an iterator which can be used to access all the fields on the screen in a sequential manner.
 int getScreenDepth()
          Return the number of rows the screen has.
 int getScreenWidth()
          Return the number of columns on the screen.
 
Methods inherited from interface javax.resource.cci.Record
clone, equals, getRecordName, getRecordShortDescription, hashCode, setRecordName, setRecordShortDescription
 

Method Detail

getField

EPIFieldRecord getField(int index)
                        throws ScreenException
Returns a field at the given index. Range is 1 to number of fields on the screen.

Parameters:
index - The field index.
Returns:
An EPI Field Record.
Throws:
ScreenException - Throws a Screen Exception if an invalid field index is given.

getFieldCount

int getFieldCount()
Returns the number of fields on the screen.

Returns:
Number of fields.

getFields

java.util.Iterator getFields()
This returns an iterator which can be used to access all the fields on the screen in a sequential manner.

Returns:
A field iterator.

getScreenDepth

int getScreenDepth()
Return the number of rows the screen has.

Returns:
The Screen depth.

getScreenWidth

int getScreenWidth()
Return the number of columns on the screen.

Returns:
The Screen Width.

©Copyright IBM Corp. 1994, 2014
Legal