Interface EPIScreenRecord

All Superinterfaces:
Cloneable, jakarta.resource.cci.Record, Serializable
All Known Implementing Classes:
EPIScreenRecordImpl

public interface EPIScreenRecord extends jakarta.resource.cci.Record
This interface represents a screen, and provides methods for querying information about the screen and for retrieving fields from the screen.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final String
     
  • Method Summary

    Modifier and Type
    Method
    Description
    getField(int index)
    Returns a field at the given index.
    int
    Returns the number of fields on the screen.
    This returns an iterator which can be used to access all the fields on the screen in a sequential manner.
    int
    Return the number of rows the screen has.
    int
    Return the number of columns on the screen.

    Methods inherited from interface jakarta.resource.cci.Record

    clone, equals, getRecordName, getRecordShortDescription, hashCode, setRecordName, setRecordShortDescription
  • Field Details

  • Method Details

    • getField

      EPIFieldRecord getField(int index) throws com.ibm.connector2.screen.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:
      com.ibm.connector2.screen.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

      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.