All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface org.ohio.iOhio

public interface iOhio
Base interface provided by all iOhio interfaces. Contains all common iOhio methods and properties. The iOhio interface contains the following enumerations:

OHIO_DIRECTION

Constant Value Description
OHIO_DIRECTION_FORWARD 0 Forward (beginning towards end)
OHIO_DIRECTION_BACKWARD 1 Backward (end towards beginning)

This enum is used by:

OHIO_TYPE

Constant Value Description
OHIO_TYPE_UNKNOWN 0 Unknown host
OHIO_TYPE_3270 1 3270 host
OHIO_TYPE_5250 2 5250 host

This enum is used by:

OHIO_STATE

Constant Value Description
OHIO_STATE_DISCONNECTED 0 The communication link to the host is disconnected.
OHIO_STATE_CONNECTED 1 The communication link to the host is connected.

This enum is used by:

OHIO_PLANE

Constant Value Description
OHIO_PLANE_TEXT 1 Field attr represented as spaces
OHIO_PLANE_COLOR 2 Standard HLLAPI CGA color values
OHIO_PLANE_FIELD 4 Field Attr bytes (See OHIO_FIELD)
OHIO_PLANE_EXTENDED 8 Extended attr bytes (see OHIO_EXTENDED)

This enum is used by:

OHIO_COLOR

Constant Value Description
OHIO_COLOR_BLACK 0 OHIO_EXTENDED_COLOR_DEFAULT
OHIO_COLOR_BLUE 1 OHIO_EXTENDED_COLOR_BLUE
OHIO_COLOR_GREEN 2 OHIO_EXTENDED_COLOR_GREEN
OHIO_COLOR_CYAN 3 OHIO_EXTENDED_COLOR_CYAN
OHIO_COLOR_RED 4 OHIO_EXTENDED_COLOR_RED
OHIO_COLOR_MAGENTA 5 OHIO_EXTENDED_COLOR_MAGENTA
OHIO_COLOR_WHITE 7 OHIO_EXTENDED_COLOR_WHITE
OHIO_COLOR_YELLOW 14 OHIO_EXTENDED_COLOR_YELLOW

These values are returned in the Ohio Color Plane from the following:

OHIO_EXTENDED

Constant Value Description
OHIO_EXTENDED_HILITE 0xC0 Bitmask for Highlighting Bits
OHIO_EXTENDED_COLOR 0x38 Bitmask for Color Bits
OHIO_EXTENDED_RESERVED 0x07 Bitmask for Reserved Bits
OHIO_EXTENDED_HILITE_NORMAL 0 Normal highlighting
OHIO_EXTENDED_HILITE_BLINK 1 Blinking highlighting
OHIO_EXTENDED_HILITE_REVERSEVIDEO 2 Reverse Video highlighting
OHIO_EXTENDED_HILITE_UNDERSCORE 3 Underscore highlighting
OHIO_EXTENDED_COLOR_DEFAULT 0 Default color
OHIO_EXTENDED_COLOR_BLUE 1 Blue
OHIO_EXTENDED_COLOR_RED 2 Red
OHIO_EXTENDED_COLOR_PINK 3 Pink
OHIO_EXTENDED_COLOR_GREEN 4 Green
OHIO_EXTENDED_COLOR_TURQUOISE 5 Turquoise
OHIO_EXTENDED_COLOR_YELLOW 6 Yellow
OHIO_EXTENDED_COLOR_WHITE 7 White

These values are returned in the Ohio Extended Field Plane from the following:

OHIO_FIELD

Constant Value Description
OHIO_FIELD_ATTRIBUTE 0xC0 Bitmask for field attribute
OHIO_FIELD_PROTECTED 0x20 Protected field
OHIO_FIELD_NUMERIC 0x10 Numeric field
OHIO_FIELD_PEN_SELECTABLE 0x08 Pen selectable field
OHIO_FIELD_HIGH_INTENSITY 0x04 High intensity field
OHIO_FIELD_HIDDEN 0x0C Hidden field
OHIO_FIELD_RESERVED 0x02 Reserved field
OHIO_FIELD_MODIFIED 0x01 Modified field

These values are returned in the Ohio Field Attributes from the following:

OHIO_UPDATE

Constant Value Description
OHIO_UPDATE_CLIENT 0 Update initiated by client
OHIO_UPDATE_HOST 1 Update initiated by host

This enum is used by:

OHIO_OWNER

Constant Value Description
OHIO_OWNER_UNKNOWN 0 Uninitialized
OHIO_OWNER_APP 1 Application or 5250 host
OHIO_OWNER_MYJOB 1 3270 - Myjob
OHIO_OWNER_NVT 2 3270 in NVT mode
OHIO_OWNER_UNOWNED 3 3270 - Unowned
OHIO_OWNER_SSCP 4 3270 - SSCP

This enum is used by:

OHIO_INPUTINHIBITED

Constant Value Description
OHIO_INPUTINHIBITED_NOTINHIBITED 0 Input not inhibited
OHIO_INPUTINHIBITED_SYSTEM_WAIT 1 Input inhibited by a System Wait state ("X SYSTEM" or "X []")
OHIO_INPUTINHIBITED_COMMCHECK 2 Input inhibited by a communications check state ("X COMMxxx")
OHIO_INPUTINHIBITED_PROGCHECK 3 Input inhibited by a program check state ("X PROGxxx")
OHIO_INPUTINHIBITED_MACHINECHECK 4 Input inhibited by a machine check state ("X MACHxxx")
OHIO_INPUTINHIBITED_OTHER 5 Input inhibited by something other than above states

This enum is used by:


Variable Index

 o OHIO_COLOR_BLACK
Part of the OHIO_COLOR enum: indicates black
 o OHIO_COLOR_BLUE
Part of the OHIO_COLOR enum: indicates blue
 o OHIO_COLOR_CYAN
Part of the OHIO_COLOR enum: indicates cyan
 o OHIO_COLOR_GREEN
Part of the OHIO_COLOR enum: indicates green
 o OHIO_COLOR_MAGENTA
Part of the OHIO_COLOR enum: indicates magenta
 o OHIO_COLOR_RED
Part of the OHIO_COLOR enum: indicates red
 o OHIO_COLOR_WHITE
Part of the OHIO_COLOR enum: indicates white
 o OHIO_COLOR_YELLOW
Part of the OHIO_COLOR enum: indicates yellow
 o OHIO_DIRECTION_BACKWARD
Part of the OHIO_DIRECTION enum: indicates Backward (end towards beginning)
 o OHIO_DIRECTION_FORWARD
Part of the OHIO_DIRECTION enum: indicates Forward (beginning towards end)
 o OHIO_EXTENDED_COLOR
Part of the OHIO_EXTENDED enum: indicates color bits
 o OHIO_EXTENDED_COLOR_BLUE
Part of the OHIO_EXTENDED enum: indicates blue
 o OHIO_EXTENDED_COLOR_DEFAULT
Part of the OHIO_EXTENDED enum: indicates default color
 o OHIO_EXTENDED_COLOR_GREEN
Part of the OHIO_EXTENDED enum: indicates green
 o OHIO_EXTENDED_COLOR_PINK
Part of the OHIO_EXTENDED enum: indicates pink
 o OHIO_EXTENDED_COLOR_RED
Part of the OHIO_EXTENDED enum: indicates red
 o OHIO_EXTENDED_COLOR_TURQUOISE
Part of the OHIO_EXTENDED enum: indicates turquoise
 o OHIO_EXTENDED_COLOR_WHITE
Part of the OHIO_EXTENDED enum: indicates white
 o OHIO_EXTENDED_COLOR_YELLOW
Part of the OHIO_EXTENDED enum: indicates yellow
 o OHIO_EXTENDED_HILITE
Part of the OHIO_EXTENDED enum: indicates highlighting bits
 o OHIO_EXTENDED_HILITE_BLINK
Part of the OHIO_EXTENDED enum: indicates blinking highlighting
 o OHIO_EXTENDED_HILITE_NORMAL
Part of the OHIO_EXTENDED enum: indicates normal highlighting
 o OHIO_EXTENDED_HILITE_REVERSEVIDEO
Part of the OHIO_EXTENDED enum: indicates reverse video highlighting
 o OHIO_EXTENDED_HILITE_UNDERSCORE
Part of the OHIO_EXTENDED enum: indicates underscore highlighting
 o OHIO_EXTENDED_RESERVED
Part of the OHIO_EXTENDED enum: indicates reserved bits
 o OHIO_FIELD_ATTRIBUTE
Part of the OHIO_FIELD enum: indicates field attribute flags
 o OHIO_FIELD_HIDDEN
Part of the OHIO_FIELD enum: indicates hidden field
 o OHIO_FIELD_HIGH_INTENSITY
Part of the OHIO_FIELD enum: indicates high intensity field
 o OHIO_FIELD_MODIFIED
Part of the OHIO_FIELD enum: indicates modified field
 o OHIO_FIELD_NUMERIC
Part of the OHIO_FIELD enum: indicates numeric field
 o OHIO_FIELD_PEN_SELECTABLE
Part of the OHIO_FIELD enum: indicates pen selectable field
 o OHIO_FIELD_PROTECTED
Part of the OHIO_FIELD enum: indicates protected field
 o OHIO_FIELD_RESERVED
Part of the OHIO_FIELD enum: indicates reserved
 o OHIO_INPUTINHIBITED_COMMCHECK
Part of the OHIO_INPUTINHIBITED enum: input inhibited by communication check state
 o OHIO_INPUTINHIBITED_MACHINECHECK
Part of the OHIO_INPUTINHIBITED enum: input inhibited by machine check state
 o OHIO_INPUTINHIBITED_NOTINHIBITED
Part of the OHIO_INPUTINHIBITED enum: input not inhibited
 o OHIO_INPUTINHIBITED_OTHER
Part of the OHIO_INPUTINHIBITED enum: input inhibited by other state
 o OHIO_INPUTINHIBITED_PROGCHECK
Part of the OHIO_INPUTINHIBITED enum: input inhibited by program check state
 o OHIO_INPUTINHIBITED_SYSTEM_WAIT
Part of the OHIO_INPUTINHIBITED enum: input inhibited by system wait state
 o OHIO_OWNER_APP
Part of the OHIO_OWNER enum: indicates application or 5250 owner
 o OHIO_OWNER_MYJOB
Part of the OHIO_OWNER enum: indicates 3270 - Myjob owner
 o OHIO_OWNER_NVT
Part of the OHIO_OWNER enum: indicates 3270 - NVT owner
 o OHIO_OWNER_SSCP
Part of the OHIO_OWNER enum: indicates 3270 - SSCP owner
 o OHIO_OWNER_UNKNOWN
Part of the OHIO_OWNER enum: indicates unknown owner
 o OHIO_OWNER_UNOWNED
Part of the OHIO_OWNER enum: indicates 3270 - unowned
 o OHIO_PLANE_COLOR
Part of the OHIO_PLANE enum: indicates color plane
 o OHIO_PLANE_EXTENDED
Part of the OHIO_PLANE enum: indicates extended attribute plane
 o OHIO_PLANE_FIELD
Part of the OHIO_PLANE enum: indicates field plane
 o OHIO_PLANE_TEXT
Part of the OHIO_PLANE enum: indicates text plane
 o OHIO_STATE_CONNECTED
Part of the OHIO_STATE enum: indicates host is connected.
 o OHIO_STATE_DISCONNECTED
Part of the OHIO_STATE enum: indicates host is disconnected.
 o OHIO_TYPE_3270
Part of the OHIO_TYPE enum: indicates 3270
 o OHIO_TYPE_5250
Part of the OHIO_TYPE enum: indicates 5250
 o OHIO_TYPE_UNKNOWN
Part of the OHIO_TYPE enum: indicates unknown type
 o OHIO_UPDATE_CLIENT
Part of the OHIO_UPDATE enum: indicates client generated update
 o OHIO_UPDATE_HOST
Part of the OHIO_UPDATE enum: indicates host generated update

Method Index

 o getOhioVersion()
Returns the OHIO version level of this implementation.
 o getVendorName()
Returns the name of the vendor providing this OHIO implementation.
 o getVendorObject()
Returns the Host Access Class Library (HACL) specific implementation of this object.
 o getVendorProductVersion()
Returns the vendor product version that is providing the OHIO implementation.

Variables

 o OHIO_DIRECTION_FORWARD
 public static final int OHIO_DIRECTION_FORWARD
Part of the OHIO_DIRECTION enum: indicates Forward (beginning towards end)

 o OHIO_DIRECTION_BACKWARD
 public static final int OHIO_DIRECTION_BACKWARD
Part of the OHIO_DIRECTION enum: indicates Backward (end towards beginning)

 o OHIO_TYPE_UNKNOWN
 public static final int OHIO_TYPE_UNKNOWN
Part of the OHIO_TYPE enum: indicates unknown type

 o OHIO_TYPE_3270
 public static final int OHIO_TYPE_3270
Part of the OHIO_TYPE enum: indicates 3270

 o OHIO_TYPE_5250
 public static final int OHIO_TYPE_5250
Part of the OHIO_TYPE enum: indicates 5250

 o OHIO_STATE_DISCONNECTED
 public static final int OHIO_STATE_DISCONNECTED
Part of the OHIO_STATE enum: indicates host is disconnected.

 o OHIO_STATE_CONNECTED
 public static final int OHIO_STATE_CONNECTED
Part of the OHIO_STATE enum: indicates host is connected.

 o OHIO_PLANE_TEXT
 public static final int OHIO_PLANE_TEXT
Part of the OHIO_PLANE enum: indicates text plane

 o OHIO_PLANE_COLOR
 public static final int OHIO_PLANE_COLOR
Part of the OHIO_PLANE enum: indicates color plane

 o OHIO_PLANE_FIELD
 public static final int OHIO_PLANE_FIELD
Part of the OHIO_PLANE enum: indicates field plane

 o OHIO_PLANE_EXTENDED
 public static final int OHIO_PLANE_EXTENDED
Part of the OHIO_PLANE enum: indicates extended attribute plane

 o OHIO_COLOR_BLACK
 public static final int OHIO_COLOR_BLACK
Part of the OHIO_COLOR enum: indicates black

 o OHIO_COLOR_BLUE
 public static final int OHIO_COLOR_BLUE
Part of the OHIO_COLOR enum: indicates blue

 o OHIO_COLOR_GREEN
 public static final int OHIO_COLOR_GREEN
Part of the OHIO_COLOR enum: indicates green

 o OHIO_COLOR_CYAN
 public static final int OHIO_COLOR_CYAN
Part of the OHIO_COLOR enum: indicates cyan

 o OHIO_COLOR_RED
 public static final int OHIO_COLOR_RED
Part of the OHIO_COLOR enum: indicates red

 o OHIO_COLOR_MAGENTA
 public static final int OHIO_COLOR_MAGENTA
Part of the OHIO_COLOR enum: indicates magenta

 o OHIO_COLOR_WHITE
 public static final int OHIO_COLOR_WHITE
Part of the OHIO_COLOR enum: indicates white

 o OHIO_COLOR_YELLOW
 public static final int OHIO_COLOR_YELLOW
Part of the OHIO_COLOR enum: indicates yellow

 o OHIO_EXTENDED_HILITE
 public static final int OHIO_EXTENDED_HILITE
Part of the OHIO_EXTENDED enum: indicates highlighting bits

 o OHIO_EXTENDED_COLOR
 public static final int OHIO_EXTENDED_COLOR
Part of the OHIO_EXTENDED enum: indicates color bits

 o OHIO_EXTENDED_RESERVED
 public static final int OHIO_EXTENDED_RESERVED
Part of the OHIO_EXTENDED enum: indicates reserved bits

 o OHIO_EXTENDED_HILITE_NORMAL
 public static final int OHIO_EXTENDED_HILITE_NORMAL
Part of the OHIO_EXTENDED enum: indicates normal highlighting

 o OHIO_EXTENDED_HILITE_BLINK
 public static final int OHIO_EXTENDED_HILITE_BLINK
Part of the OHIO_EXTENDED enum: indicates blinking highlighting

 o OHIO_EXTENDED_HILITE_REVERSEVIDEO
 public static final int OHIO_EXTENDED_HILITE_REVERSEVIDEO
Part of the OHIO_EXTENDED enum: indicates reverse video highlighting

 o OHIO_EXTENDED_HILITE_UNDERSCORE
 public static final int OHIO_EXTENDED_HILITE_UNDERSCORE
Part of the OHIO_EXTENDED enum: indicates underscore highlighting

 o OHIO_EXTENDED_COLOR_DEFAULT
 public static final int OHIO_EXTENDED_COLOR_DEFAULT
Part of the OHIO_EXTENDED enum: indicates default color

 o OHIO_EXTENDED_COLOR_BLUE
 public static final int OHIO_EXTENDED_COLOR_BLUE
Part of the OHIO_EXTENDED enum: indicates blue

 o OHIO_EXTENDED_COLOR_RED
 public static final int OHIO_EXTENDED_COLOR_RED
Part of the OHIO_EXTENDED enum: indicates red

 o OHIO_EXTENDED_COLOR_PINK
 public static final int OHIO_EXTENDED_COLOR_PINK
Part of the OHIO_EXTENDED enum: indicates pink

 o OHIO_EXTENDED_COLOR_GREEN
 public static final int OHIO_EXTENDED_COLOR_GREEN
Part of the OHIO_EXTENDED enum: indicates green

 o OHIO_EXTENDED_COLOR_TURQUOISE
 public static final int OHIO_EXTENDED_COLOR_TURQUOISE
Part of the OHIO_EXTENDED enum: indicates turquoise

 o OHIO_EXTENDED_COLOR_YELLOW
 public static final int OHIO_EXTENDED_COLOR_YELLOW
Part of the OHIO_EXTENDED enum: indicates yellow

 o OHIO_EXTENDED_COLOR_WHITE
 public static final int OHIO_EXTENDED_COLOR_WHITE
Part of the OHIO_EXTENDED enum: indicates white

 o OHIO_FIELD_ATTRIBUTE
 public static final int OHIO_FIELD_ATTRIBUTE
Part of the OHIO_FIELD enum: indicates field attribute flags

 o OHIO_FIELD_PROTECTED
 public static final int OHIO_FIELD_PROTECTED
Part of the OHIO_FIELD enum: indicates protected field

 o OHIO_FIELD_NUMERIC
 public static final int OHIO_FIELD_NUMERIC
Part of the OHIO_FIELD enum: indicates numeric field

 o OHIO_FIELD_PEN_SELECTABLE
 public static final int OHIO_FIELD_PEN_SELECTABLE
Part of the OHIO_FIELD enum: indicates pen selectable field

 o OHIO_FIELD_HIGH_INTENSITY
 public static final int OHIO_FIELD_HIGH_INTENSITY
Part of the OHIO_FIELD enum: indicates high intensity field

 o OHIO_FIELD_HIDDEN
 public static final int OHIO_FIELD_HIDDEN
Part of the OHIO_FIELD enum: indicates hidden field

 o OHIO_FIELD_RESERVED
 public static final int OHIO_FIELD_RESERVED
Part of the OHIO_FIELD enum: indicates reserved

 o OHIO_FIELD_MODIFIED
 public static final int OHIO_FIELD_MODIFIED
Part of the OHIO_FIELD enum: indicates modified field

 o OHIO_UPDATE_HOST
 public static final int OHIO_UPDATE_HOST
Part of the OHIO_UPDATE enum: indicates host generated update

 o OHIO_UPDATE_CLIENT
 public static final int OHIO_UPDATE_CLIENT
Part of the OHIO_UPDATE enum: indicates client generated update

 o OHIO_OWNER_UNKNOWN
 public static final int OHIO_OWNER_UNKNOWN
Part of the OHIO_OWNER enum: indicates unknown owner

 o OHIO_OWNER_APP
 public static final int OHIO_OWNER_APP
Part of the OHIO_OWNER enum: indicates application or 5250 owner

 o OHIO_OWNER_MYJOB
 public static final int OHIO_OWNER_MYJOB
Part of the OHIO_OWNER enum: indicates 3270 - Myjob owner

 o OHIO_OWNER_NVT
 public static final int OHIO_OWNER_NVT
Part of the OHIO_OWNER enum: indicates 3270 - NVT owner

 o OHIO_OWNER_UNOWNED
 public static final int OHIO_OWNER_UNOWNED
Part of the OHIO_OWNER enum: indicates 3270 - unowned

 o OHIO_OWNER_SSCP
 public static final int OHIO_OWNER_SSCP
Part of the OHIO_OWNER enum: indicates 3270 - SSCP owner

 o OHIO_INPUTINHIBITED_NOTINHIBITED
 public static final int OHIO_INPUTINHIBITED_NOTINHIBITED
Part of the OHIO_INPUTINHIBITED enum: input not inhibited

 o OHIO_INPUTINHIBITED_SYSTEM_WAIT
 public static final int OHIO_INPUTINHIBITED_SYSTEM_WAIT
Part of the OHIO_INPUTINHIBITED enum: input inhibited by system wait state

 o OHIO_INPUTINHIBITED_COMMCHECK
 public static final int OHIO_INPUTINHIBITED_COMMCHECK
Part of the OHIO_INPUTINHIBITED enum: input inhibited by communication check state

 o OHIO_INPUTINHIBITED_PROGCHECK
 public static final int OHIO_INPUTINHIBITED_PROGCHECK
Part of the OHIO_INPUTINHIBITED enum: input inhibited by program check state

 o OHIO_INPUTINHIBITED_MACHINECHECK
 public static final int OHIO_INPUTINHIBITED_MACHINECHECK
Part of the OHIO_INPUTINHIBITED enum: input inhibited by machine check state

 o OHIO_INPUTINHIBITED_OTHER
 public static final int OHIO_INPUTINHIBITED_OTHER
Part of the OHIO_INPUTINHIBITED enum: input inhibited by other state

Methods

 o getOhioVersion
 public abstract String getOhioVersion()
Returns the OHIO version level of this implementation.

Returns:
The OHIO version level, "OHIO 1.00".
 o getVendorName
 public abstract String getVendorName()
Returns the name of the vendor providing this OHIO implementation.

Returns:
The vendor name, "IBM".
 o getVendorProductVersion
 public abstract String getVendorProductVersion()
Returns the vendor product version that is providing the OHIO implementation.

Returns:
The vendor product version, "Host Access Class Library 3.0"
 o getVendorObject
 public abstract Object getVendorObject()
Returns the Host Access Class Library (HACL) specific implementation of this object.

Returns:
The HACL specific equivalent to this OHIO object.

All Packages  Class Hierarchy  This Package  Previous  Next  Index