com.ibm.cics.model
Interface ITerminal

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource, com.ibm.cics.model.meta.ITypedObject

public interface ITerminal
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable TERMNL


Nested Class Summary
static class ITerminal.AccessmethodValue
          Enumeration type for field ACCESSMETHOD
static class ITerminal.AcquireStatusValue
          Enumeration type for field ACQSTATUS
static class ITerminal.AltprtcopystValue
          Enumeration type for field ALTPRTCOPYST
static class ITerminal.AplkybdstValue
          Enumeration type for field APLKYBDST
static class ITerminal.ApltextstValue
          Enumeration type for field APLTEXTST
static class ITerminal.AsciiValue
          Enumeration type for field ASCII
static class ITerminal.ATIStatusValue
          Enumeration type for field ATISTATUS
static class ITerminal.AudalarmstValue
          Enumeration type for field AUDALARMST
static class ITerminal.AutoconnectValue
          Enumeration type for field AUTOCONNECT
static class ITerminal.BacktransstValue
          Enumeration type for field BACKTRANSST
static class ITerminal.ColorstValue
          Enumeration type for field COLORST
static class ITerminal.CopystValue
          Enumeration type for field COPYST
static class ITerminal.DatastreamValue
          Enumeration type for field DATASTREAM
static class ITerminal.DiscreqstValue
          Enumeration type for field DISCREQST
static class ITerminal.DualcasestValue
          Enumeration type for field DUALCASEST
static class ITerminal.ExittracingValue
          Enumeration type for field EXITTRACING
static class ITerminal.ExtendeddsstValue
          Enumeration type for field EXTENDEDDSST
static class ITerminal.FmhparmstValue
          Enumeration type for field FMHPARMST
static class ITerminal.FormfeedstValue
          Enumeration type for field FORMFEEDST
static class ITerminal.HformstValue
          Enumeration type for field HFORMST
static class ITerminal.HilightstValue
          Enumeration type for field HILIGHTST
static class ITerminal.KatakanastValue
          Enumeration type for field KATAKANAST
static class ITerminal.LightpenstValue
          Enumeration type for field LIGHTPENST
static class ITerminal.MsrcontrolstValue
          Enumeration type for field MSRCONTROLST
static class ITerminal.ObformatstValue
          Enumeration type for field OBFORMATST
static class ITerminal.OboperidstValue
          Enumeration type for field OBOPERIDST
static class ITerminal.OutlinestValue
          Enumeration type for field OUTLINEST
static class ITerminal.PagestatusValue
          Enumeration type for field PAGESTATUS
static class ITerminal.PartitionsstValue
          Enumeration type for field PARTITIONSST
static class ITerminal.PrintadaptstValue
          Enumeration type for field PRINTADAPTST
static class ITerminal.ProgsymbolstValue
          Enumeration type for field PROGSYMBOLST
static class ITerminal.PrtcopystValue
          Enumeration type for field PRTCOPYST
static class ITerminal.QuerystValue
          Enumeration type for field QUERYST
static class ITerminal.RelreqstValue
          Enumeration type for field RELREQST
static class ITerminal.SecurityValue
          Enumeration type for field SECURITY
static class ITerminal.ServiceStatusValue
          Enumeration type for field SERVSTATUS
static class ITerminal.SessionStatusValue
          Enumeration type for field CREATESESS
static class ITerminal.SessiontypeValue
          Enumeration type for field SESSIONTYPE
static class ITerminal.SignonstatusValue
          Enumeration type for field SIGNONSTATUS
static class ITerminal.SosistValue
          Enumeration type for field SOSIST
static class ITerminal.TextkybdstValue
          Enumeration type for field TEXTKYBDST
static class ITerminal.TextprintstValue
          Enumeration type for field TEXTPRINTST
static class ITerminal.TracingValue
          Enumeration type for field TRACING
static class ITerminal.TTIStatusValue
          Enumeration type for field TTISTATUS
static class ITerminal.UctranstValue
          Enumeration type for field UCTRANST
static class ITerminal.ValidationstValue
          Enumeration type for field VALIDATIONST
static class ITerminal.VformstValue
          Enumeration type for field VFORMST
static class ITerminal.ZcptracingValue
          Enumeration type for field ZCPTRACING
 
Method Summary
 ITerminal.AccessmethodValue getAccessmethod()
          Getter for field ACCESSMETHOD
 ITerminal.AcquireStatusValue getAcquireStatus()
          Getter for field ACQSTATUS
 java.lang.Long getAltpageht()
          Getter for field ALTPAGEHT
 java.lang.Long getAltpagewd()
          Getter for field ALTPAGEWD
 java.lang.String getAltprinter()
          Getter for field ALTPRINTER
 ITerminal.AltprtcopystValue getAltprtcopyst()
          Getter for field ALTPRTCOPYST
 java.lang.Long getAltscrnht()
          Getter for field ALTSCRNHT
 java.lang.Long getAltscrnwd()
          Getter for field ALTSCRNWD
 java.lang.String getAltsuffix()
          Getter for field ALTSUFFIX
 ITerminal.AplkybdstValue getAplkybdst()
          Getter for field APLKYBDST
 ITerminal.ApltextstValue getApltextst()
          Getter for field APLTEXTST
 ITerminal.AsciiValue getAscii()
          Getter for field ASCII
 ITerminal.ATIStatusValue getATIStatus()
          Getter for field ATISTATUS
 ITerminal.AudalarmstValue getAudalarmst()
          Getter for field AUDALARMST
 ITerminal.AutoconnectValue getAutoconnect()
          Getter for field AUTOCONNECT
 ITerminal.BacktransstValue getBacktransst()
          Getter for field BACKTRANSST
 ITerminal.ColorstValue getColorst()
          Getter for field COLORST
 java.lang.String getConsole()
          Getter for field CONSOLE
 ITerminal.CopystValue getCopyst()
          Getter for field COPYST
 java.lang.String getCorrelid()
          Getter for field CORRELID
 ITerminal.DatastreamValue getDatastream()
          Getter for field DATASTREAM
 java.lang.Long getDefpageht()
          Getter for field DEFPAGEHT
 java.lang.Long getDefpagewd()
          Getter for field DEFPAGEWD
 java.lang.Long getDefscrnht()
          Getter for field DEFSCRNHT
 java.lang.Long getDefscrnwd()
          Getter for field DEFSCRNWD
 java.lang.String getDevice()
          Getter for field DEVICE
 ITerminal.DiscreqstValue getDiscreqst()
          Getter for field DISCREQST
 ITerminal.DualcasestValue getDualcasest()
          Getter for field DUALCASEST
 ITerminal.ExittracingValue getExittracing()
          Getter for field EXITTRACING
 ITerminal.ExtendeddsstValue getExtendeddsst()
          Getter for field EXTENDEDDSST
 ITerminal.FmhparmstValue getFmhparmst()
          Getter for field FMHPARMST
 ITerminal.FormfeedstValue getFormfeedst()
          Getter for field FORMFEEDST
 java.lang.Long getGchars()
          Getter for field GCHARS
 java.lang.Long getGcodes()
          Getter for field GCODES
 ITerminal.HformstValue getHformst()
          Getter for field HFORMST
 ITerminal.HilightstValue getHilightst()
          Getter for field HILIGHTST
 java.lang.Long getInpmsgcnt()
          Getter for field INPMSGCNT
 ITerminal.KatakanastValue getKatakanast()
          Getter for field KATAKANAST
 ITerminal.LightpenstValue getLightpenst()
          Getter for field LIGHTPENST
 java.lang.String getLinksystem()
          Getter for field LINKSYSTEM
 java.lang.String getMapname()
          Getter for field MAPNAME
 java.lang.String getMapsetname()
          Getter for field MAPSETNAME
 java.lang.String getModename()
          Getter for field MODENAME
 ITerminal.MsrcontrolstValue getMsrcontrolst()
          Getter for field MSRCONTROLST
 java.lang.String getName()
          Getter for field TERMID
 java.lang.String getNatlang()
          Getter for field NATLANG
 java.lang.String getNature()
          Getter for field NATURE
 java.lang.String getNetworkName()
          Getter for field NETNAME
 java.lang.String getNexttransid()
          Getter for field NEXTTRANSID
 java.lang.String getNqname()
          Getter for field NQNAME
 ITerminal.ObformatstValue getObformatst()
          Getter for field OBFORMATST
 ITerminal.OboperidstValue getOboperidst()
          Getter for field OBOPERIDST
 java.lang.String getOperid()
          Getter for field OPERID
 ITerminal.OutlinestValue getOutlinest()
          Getter for field OUTLINEST
 java.lang.Long getOutmsgcnt()
          Getter for field OUTMSGCNT
 java.lang.Long getPageht()
          Getter for field PAGEHT
 ITerminal.PagestatusValue getPagestatus()
          Getter for field PAGESTATUS
 java.lang.Long getPagewd()
          Getter for field PAGEWD
 ITerminal.PartitionsstValue getPartitionsst()
          Getter for field PARTITIONSST
 java.lang.Long getPmsgcnt()
          Getter for field PMSGCNT
 java.lang.Long getPmsgconsec()
          Getter for field PMSGCONSEC
 java.lang.Long getPmsggrpcnt()
          Getter for field PMSGGRPCNT
 java.lang.String getPollcnt()
          Getter for field POLLCNT
 ITerminal.PrintadaptstValue getPrintadaptst()
          Getter for field PRINTADAPTST
 java.lang.String getPrinter()
          Getter for field PRINTER
 ITerminal.ProgsymbolstValue getProgsymbolst()
          Getter for field PROGSYMBOLST
 ITerminal.PrtcopystValue getPrtcopyst()
          Getter for field PRTCOPYST
 ITerminal.QuerystValue getQueryst()
          Getter for field QUERYST
 ITerminal.RelreqstValue getRelreqst()
          Getter for field RELREQST
 java.lang.String getRemotename()
          Getter for field REMOTENAME
 java.lang.String getRemotesysnet()
          Getter for field REMOTESYSNET
 java.lang.String getRemotesystem()
          Getter for field REMOTESYSTEM
 java.lang.Long getScreenheight()
          Getter for field SCREENHEIGHT
 java.lang.Long getScreenwidth()
          Getter for field SCREENWIDTH
 ITerminal.SecurityValue getSecurity()
          Getter for field SECURITY
 ITerminal.ServiceStatusValue getServiceStatus()
          Getter for field SERVSTATUS
 ITerminal.SessionStatusValue getSessionStatus()
          Getter for field CREATESESS
 ITerminal.SessiontypeValue getSessiontype()
          Getter for field SESSIONTYPE
 ITerminal.SignonstatusValue getSignonstatus()
          Getter for field SIGNONSTATUS
 ITerminal.SosistValue getSosist()
          Getter for field SOSIST
 java.lang.Long getStgvcnt()
          Getter for field STGVCNT
 java.lang.Long getStorage()
          Getter for field STORAGE
 java.lang.Long getTaskID()
          Getter for field TASKID
 java.lang.String getTcamcontrol()
          Getter for field TCAMCONTROL
 java.lang.Long getTermmodel()
          Getter for field TERMMODEL
 java.lang.Long getTermpriority()
          Getter for field TERMPRIORITY
 java.lang.Long getTermtype()
          Getter for field TERMTYPE
 java.lang.Long getTerrcnt()
          Getter for field TERRCNT
 ITerminal.TextkybdstValue getTextkybdst()
          Getter for field TEXTKYBDST
 ITerminal.TextprintstValue getTextprintst()
          Getter for field TEXTPRINTST
 ITerminal.TracingValue getTracing()
          Getter for field TRACING
 java.lang.Long getTrancnt()
          Getter for field TRANCNT
 java.lang.String getTransactionID()
          Getter for field TRANSACTION
 ITerminal.TTIStatusValue getTTIStatus()
          Getter for field TTISTATUS
 ITerminal.UctranstValue getUctranst()
          Getter for field UCTRANST
 java.lang.String getUserarea()
          Getter for field USERAREA
 java.lang.Long getUserarealen()
          Getter for field USERAREALEN
 java.lang.String getUserID()
          Getter for field USERID
 java.lang.String getUsername()
          Getter for field USERNAME
 ITerminal.ValidationstValue getValidationst()
          Getter for field VALIDATIONST
 ITerminal.VformstValue getVformst()
          Getter for field VFORMST
 java.lang.Long getXerrcnt()
          Getter for field XERRCNT
 ITerminal.ZcptracingValue getZcptracing()
          Getter for field ZCPTRACING
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getObjectType
 

Method Detail

getName

java.lang.String getName()
Getter for field TERMID

Terminal ID

The terminal name as specified in the installed terminal definition.

Specified by:
getName in interface ICICSObject

getAcquireStatus

ITerminal.AcquireStatusValue getAcquireStatus()
Getter for field ACQSTATUS

Acquire status

Under VTAM, indicates whether CICS is in session with the logical unit represented by this terminal. If this field is NOTAPPLIC, it means the access method is something other than VTAM. Input Values:


getATIStatus

ITerminal.ATIStatusValue getATIStatus()
Getter for field ATISTATUS

Automatic transaction initiation (ATI) status

Indicates whether CICS can initiate a task automatically (ATI) with this terminal as its principal facility.

Input Values: ATI, NOATI


getSessionStatus

ITerminal.SessionStatusValue getSessionStatus()
Getter for field CREATESESS

Session creation status

Under VTAM, indicates whether the terminal can be acquired automatically by ATI transactions. If this field is NOTAPPLIC, it means the access method is something other than VTAM. The options are CREATE, NOCREATE, NOTAPPLIC.


getAccessmethod

ITerminal.AccessmethodValue getAccessmethod()
Getter for field ACCESSMETHOD

Access method

The access method defined for the terminal as one of the following:


getSecurity

ITerminal.SecurityValue getSecurity()
Getter for field SECURITY

Preset security status

Indicates whether the terminal has preset security (PRESET or NOPRESET).


getDevice

java.lang.String getDevice()
Getter for field DEVICE

Device type

The terminal or session type as recorded in the TCTTE.

Possible values: BATCHLU, BIPROG, BISYNCH, CDRDLPRT, CONTNLU, HARDCOPY, INTACTLU, ISCMMCONV, LUCMODGRP, LUCSESS, LUTYPE4, LUTYPE6, MAGTAPE, RESSYS, SDLC, SEQDISK, SYSTEM3, SYSTEM7, SYS7BSCA, TCONSOLE, TELETYPE, TTCAM, TWX3335, T1050, T1053, T2260L, T2260R, T2265, T2740, T2741BCD, T2741COR, T2770, T2780, T3275R, T3277L, T3277R, T3284L, T3284R, T3286L, T3286R, T3600BI, T3601, T3614, T3650ATT, T3735, T3650PIPE, T3650USER, T3653HOST, T3740, T3780, T3790, T3790SCSP, T3790UP, T7770, VIDEOTERM


getExittracing

ITerminal.ExittracingValue getExittracing()
Getter for field EXITTRACING

Exit tracing status

Under VTAM, indicates whether exit tracing is active for the terminal. A value of NOTAPPLIC means the access method is something other than VTAM.

Input Values: EXITTRACE, NOEXITTRACE


getGchars

java.lang.Long getGchars()
Getter for field GCHARS

Graphic character set global ID

The graphic character set global ID (GCSGID). This ID is a registered number in the range 1 - 65534 that identifies the set of graphic characters that can be input or output at this terminal. A value of zero means no GCSGID value was defined.


getGcodes

java.lang.Long getGcodes()
Getter for field GCODES

Code page global ID

The code page global ID (CPGID). This ID is a registered number in the range 1 - 65534 that identifies the EBCDIC code page that defines the code points for the characters that can be input or output at this terminal. A value of zero means no CPGID value was defined.


getModename

java.lang.String getModename()
Getter for field MODENAME

Mode name

Under APPC, the name of a group of parallel sessions (to which this terminal belongs) that have similar characteristics.


getNature

java.lang.String getNature()
Getter for field NATURE

Terminal definition type

Indicates the nature of the terminal definition as one of the following:


getNatlang

java.lang.String getNatlang()
Getter for field NATLANG

National language ID

A 1-character alphanumeric value that identifies the national language originally defined for use with this terminal.


getNetworkName

java.lang.String getNetworkName()
Getter for field NETNAME

Network name

Under VTAM, the name by which this logical unit (either a terminal or a session) is known. If this field is blank, it means the access method is something other than VTAM.


getOperid

java.lang.String getOperid()
Getter for field OPERID

Operator ID

Returns the 3-character operator identification code of the user signed on at the terminal.

Note: If the terminal is a surrogate terminal, this value may not be current; it represents the user signed on at the time the terminal definition was shipped from the owning CICS region to this one, who may since have signed off. The OPERID may also be different from that of the user currently signed on if it has been changed with the SET TERMINAL command.


getPagestatus

ITerminal.PagestatusValue getPagestatus()
Getter for field PAGESTATUS

BMS paging status

Indicates whether pages after the first in a series are written to the terminal automatically or on request from the operator.

Input Values: AUTOPAGEABLE, PAGEABLE


getScreenheight

java.lang.Long getScreenheight()
Getter for field SCREENHEIGHT

Screen height

The height of the current 3270 screen, which is either the ALTSCRNHT or DEFSCRNHT value.


getScreenwidth

java.lang.Long getScreenwidth()
Getter for field SCREENWIDTH

Screen width

The width of the current 3270 screen, which is either the ALTSCRNWD or DEFSCRNWD value.


getServiceStatus

ITerminal.ServiceStatusValue getServiceStatus()
Getter for field SERVSTATUS

Service status

Indicates whether the terminal is currently in service, out of service, or in the process of going out of service. The options are GOINGOUT, INSERVICE, OUTSERVICE


getSignonstatus

ITerminal.SignonstatusValue getSignonstatus()
Getter for field SIGNONSTATUS

Sign-on status

Indicates whether the terminal currently has a signed on user (SIGNEDON or SIGNEDOFF).


getTaskID

java.lang.Long getTaskID()
Getter for field TASKID

Id of task currently executing at terminal

The ID of the user task currently executing at this terminal.


getTermpriority

java.lang.Long getTermpriority()
Getter for field TERMPRIORITY

Terminal priority

The priority of the terminal relative to other terminals.

Input Values: 0 - 255.


getTracing

ITerminal.TracingValue getTracing()
Getter for field TRACING

Terminal tracing type

Describes the tracing activity associated with the terminal as either standard or special. The options are STANTRACE or SPECTRACE.


getTransactionID

java.lang.String getTransactionID()
Getter for field TRANSACTION

Current transaction name

The name of the transaction currently executing with this terminal as its principal facility.


getTTIStatus

ITerminal.TTIStatusValue getTTIStatus()
Getter for field TTISTATUS

Terminal transaction initiation (TTI) status

Indicates whether this terminal can be used by transactions initiated from this terminal. The options are TTI or NOTTI


getUserarea

java.lang.String getUserarea()
Getter for field USERAREA

Terminal user area (TCTUA) address

The address of the user area.


getTermmodel

java.lang.Long getTermmodel()
Getter for field TERMMODEL

Terminal model number

The terminal model number, as specified in the TYPETERM definition. A value of N/A means this terminal is an LU6.2 or MRO session.


getUserarealen

java.lang.Long getUserarealen()
Getter for field USERAREALEN

Terminal user area (TCTUA) length

The length of the user area.


getUserID

java.lang.String getUserID()
Getter for field USERID

User ID

The 8-character identifier of the user signed on at this terminal or session. If there is no signed-on user, the value will be the default user ID, as specified in the DFLTUSER system initialization parameter.


getZcptracing

ITerminal.ZcptracingValue getZcptracing()
Getter for field ZCPTRACING

ZCP tracing status

Under VTAM, controls the tracing activity associated with the VTAM control component of CICS. A value of NOTAPPLIC means the access method is something other than VTAM. The options are ZCPTRACE or NOZCPTRACE.


getNexttransid

java.lang.String getNexttransid()
Getter for field NEXTTRANSID

Next transaction ID

The name of the next transaction to run after an EXEC CICS RETURN command.

Input Values: Any valid transaction ID


getSessiontype

ITerminal.SessiontypeValue getSessiontype()
Getter for field SESSIONTYPE

Session type

For terminals that are acting as sessions with another CICS system, the type of session as one of the following:


getUsername

java.lang.String getUsername()
Getter for field USERNAME

User name

returns the 20-character name of the user signed on at this terminal or session (that is, the name corresponding to the USERID option value). If the information, which is provided by the external security manager, is shorter than 20 bytes, CICS pads it to 20 with trailing blanks. Blanks are returned if there is no signed on user.


getRemotename

java.lang.String getRemotename()
Getter for field REMOTENAME

Name of terminal in remote CICS

The 4-character name of this terminal in the remote CICS region in which it is defined. REMOTENAME applies only to terminals defined as remote; for others the value returned is blanks


getRemotesystem

java.lang.String getRemotesystem()
Getter for field REMOTESYSTEM

Remote system name

returns the 4-character name of a connection or the first 4 characters of an IPCONN name.

The named connection can be either a connection entry that that links towards the TOR, or an indirect connection that provides the netname of the TOR.

For IPIC connections, the first 4 characters of the IPCONN name on the IPCONN definition which is in service and acquired is used.


getPollcnt

java.lang.String getPollcnt()
Getter for field POLLCNT

Number of polls sent to terminal

Under TCAM or BSAM, the number of polls that have been sent to the terminal. If this field is blank, it means the access method is something other than TCAM or BSAM.


getInpmsgcnt

java.lang.Long getInpmsgcnt()
Getter for field INPMSGCNT

Number of input messages

The number of operator-initiated inputs to the terminal, including initial transaction input and input as a result of a conversational read to the terminal.


getOutmsgcnt

java.lang.Long getOutmsgcnt()
Getter for field OUTMSGCNT

Number of output messages

The number of output messages written to the terminal by either an application program or CICS.


getTrancnt

java.lang.Long getTrancnt()
Getter for field TRANCNT

Number of transactions

The number of transactions, both nonconversational and pseudoconversational, that were started at the terminal.


getStgvcnt

java.lang.Long getStgvcnt()
Getter for field STGVCNT

Number of storage violations

The number of storage violations that have occurred on the terminal.


getXerrcnt

java.lang.Long getXerrcnt()
Getter for field XERRCNT

Number of transmission errors or disconnects

The number of errors recorded if this is a terminal or the number of disconnects if this is an EXCI session.


getTerrcnt

java.lang.Long getTerrcnt()
Getter for field TERRCNT

Number of transaction errors

The number of transactions associated with the terminal that could not be started.


getPmsgcnt

java.lang.Long getPmsgcnt()
Getter for field PMSGCNT

Total pipeline-throwaway count

The total throwaway count. A throwaway occurs when input is received for a pipeline pool terminal and none are available.


getPmsggrpcnt

java.lang.Long getPmsggrpcnt()
Getter for field PMSGGRPCNT

Number of consecutive pipeline-throwaways

The number of consecutive throwaways. A throwaway occurs when input is received for a pipeline pool terminal and none are available.


getPmsgconsec

java.lang.Long getPmsgconsec()
Getter for field PMSGCONSEC

Maximum pipeline-throwaway count

The maximum number of throwaways. A throwaway occurs when input is received for a pipeline pool terminal and none are available.


getTermtype

java.lang.Long getTermtype()
Getter for field TERMTYPE

Terminal type

The type of terminal.


getTcamcontrol

java.lang.String getTcamcontrol()
Getter for field TCAMCONTROL

TCAM message control flag

Returns a 1-character TCAM control byte giving one of the following codes to identify which segment of a message has passed between CICS and TCAM. The meanings are:


getAltpageht

java.lang.Long getAltpageht()
Getter for field ALTPAGEHT

Alternate page height

The alternate page height defined for use by BMS when the alternate page size is selected.


getAltpagewd

java.lang.Long getAltpagewd()
Getter for field ALTPAGEWD

Alternate page width

The alternate page width defined for use by BMS when the alternate page size is selected.


getAltprinter

java.lang.String getAltprinter()
Getter for field ALTPRINTER

Alternate printer

The name of a 3270 printer for use as an alternative to the preferred printer.


getAltprtcopyst

ITerminal.AltprtcopystValue getAltprtcopyst()
Getter for field ALTPRTCOPYST

Hardware COPY feature for alternate printer

Indicates whether CICS is to use the hardware COPY feature to satisfy a print request from the alternate printer.

Input Values: ALTPRTCOPY, NOALTPRTCOPY


getAltscrnht

java.lang.Long getAltscrnht()
Getter for field ALTSCRNHT

Alternate screen height

The alternate screen height defined for use by BMS when the alternate screen size is selected.


getAltscrnwd

java.lang.Long getAltscrnwd()
Getter for field ALTSCRNWD

Alternate screen width

The alternate screen width defined for use by BMS when the alternate screen size is selected.


getAplkybdst

ITerminal.AplkybdstValue getAplkybdst()
Getter for field APLKYBDST

APL keyboard feature

Indicates whether the 3270 device has the APL keyboard feature. Values are APLKYBDS or NOAPLKYB.


getApltextst

ITerminal.ApltextstValue getApltextst()
Getter for field APLTEXTST

APL text feature

Indicates whether the 3270 device has the APL text feature. Values are APLTEXT or NOAPLTEX.


getAudalarmst

ITerminal.AudalarmstValue getAudalarmst()
Getter for field AUDALARMST

Audible alarm feature

Indicates whether the device has the audible alarm feature for a 3270 display or a 3270 printer attached to a 3651 controller (AUDALARM or NOAUDALARM).


getBacktransst

ITerminal.BacktransstValue getBacktransst()
Getter for field BACKTRANSST

Background transparency feature

Indicates whether the device has the background transparency feature (BACKTRANS or NOBACKTRANS).


getColorst

ITerminal.ColorstValue getColorst()
Getter for field COLORST

Extended color feature

Indicates whether the device has the extended color feature, which allows colors to be chosen for each field or character (COLOR or NOCOLOR).


getCopyst

ITerminal.CopystValue getCopyst()
Getter for field COPYST

Copy feature in control unit

Indicates whether the copy feature for a 3270 display or printer is included in the 3270 control unit (COPY or NOCOPY).


getDefpageht

java.lang.Long getDefpageht()
Getter for field DEFPAGEHT

Default page height

The default page height defined for use by BMS when the default page size is selected.


getDefpagewd

java.lang.Long getDefpagewd()
Getter for field DEFPAGEWD

Default page width

The default page width defined for use by BMS when the default page size is selected.


getDefscrnht

java.lang.Long getDefscrnht()
Getter for field DEFSCRNHT

Default screen height

The default screen height defined for use by BMS when the default screen size is selected.


getDefscrnwd

java.lang.Long getDefscrnwd()
Getter for field DEFSCRNWD

Default screen width

The default screen width defined for use by BMS when the default screen size is selected.


getDiscreqst

ITerminal.DiscreqstValue getDiscreqst()
Getter for field DISCREQST

Disconnect Requests status

Indicates whether CICS is to honor disconnect requests from an application.

Input Values: DISCREQ, NODISCREQ, NOTAPPLIC


getDualcasest

ITerminal.DualcasestValue getDualcasest()
Getter for field DUALCASEST

Dual-case keyboard status

Indicates whether the terminal has a typewriter keyboard or an operator console keyboard. Values are:


getExtendeddsst

ITerminal.ExtendeddsstValue getExtendeddsst()
Getter for field EXTENDEDDSST

Extended data stream support

Indicates whether the 3270 device or SCS printer supports extensions to the 3270 data stream. The options are EXTENDEDDS or NOEXTENDEDDS.


getFmhparmst

ITerminal.FmhparmstValue getFmhparmst()
Getter for field FMHPARMST

Function management header (FMH) option

Indicates whether the device supports function management header (FMH) data built by BMS from user-supplied parameters. The options are FMHPARM or NOFMHPARM.


getFormfeedst

ITerminal.FormfeedstValue getFormfeedst()
Getter for field FORMFEEDST

Forms feed feature

Indicates whether the device has the forms feed feature. The options are FORMFEED and NOFORMFEED.


getHilightst

ITerminal.HilightstValue getHilightst()
Getter for field HILIGHTST

Extended highlight feature

Indicates whether the 3270 device or SCS printer has the extended highlight facility, which enables fields or characters to be displayed in reverse-video, underline mode, or blinking. The options are HILIGHT or NOHILIGHT.


getHformst

ITerminal.HformstValue getHformst()
Getter for field HFORMST

Horizontal form feature

Indicates whether the device has the horizontal forms feature, which enables BMS to use horizontal tabbing when formatting documents for output. The options are HFORM or NOHFORM.


getKatakanast

ITerminal.KatakanastValue getKatakanast()
Getter for field KATAKANAST

Katakana terminal

Indicates whether the device is a Katakana terminal (KATAKANA or NOKATAKANA).


getLightpenst

ITerminal.LightpenstValue getLightpenst()
Getter for field LIGHTPENST

Selector pen feature

Indicates whether a 3270 display has the selector pen feature. The options are LIGHTPEN or NOLIGHTPEN.


getMsrcontrolst

ITerminal.MsrcontrolstValue getMsrcontrolst()
Getter for field MSRCONTROLST

Magnetic slot reader

Indicates whether the terminal is an 8775 or 3643 device with a magnetic slot reader. The options are MSRCONTR or NOMSRCON.


getObformatst

ITerminal.ObformatstValue getObformatst()
Getter for field OBFORMATST

Outboard formatting support

Indicates whether the device supports outboard formatting.

Input Values: OBFORMAT, NOOBFORMAT


getOboperidst

ITerminal.OboperidstValue getOboperidst()
Getter for field OBOPERIDST

Outboard operator IDs used

For 3790 and 3770 batch data interchange logical units, indicates whether outboard operator IDs are used by CICS to support the BMS routing facilities required for this terminal (OBOPERID or NOOBOPERID).


getOutlinest

ITerminal.OutlinestValue getOutlinest()
Getter for field OUTLINEST

Field outlining support

Indicates whether the device supports field outlining. The options are OUTLINE or NOOUTLINE.


getPageht

java.lang.Long getPageht()
Getter for field PAGEHT

Current page height

The page height currently in use for the device.


getPagewd

java.lang.Long getPagewd()
Getter for field PAGEWD

Current page width

The page width currently in use for the device.


getPartitionsst

ITerminal.PartitionsstValue getPartitionsst()
Getter for field PARTITIONSST

Partitions status

Indicates whether the device can use partitions (PARTITIONS or NOPARTITIONS).


getPrintadaptst

ITerminal.PrintadaptstValue getPrintadaptst()
Getter for field PRINTADAPTST

Printer adaptor feature

Indicates whether the device supports a printer adaptor feature (PRINTADAPT or NOPRINTADAPT).


getPrinter

java.lang.String getPrinter()
Getter for field PRINTER

Printer name

The name of the preferred printer CICS is to use in response to a print request from this device.

Input Values: Any valid printer ID


getProgsymbolst

ITerminal.ProgsymbolstValue getProgsymbolst()
Getter for field PROGSYMBOLST

Programmed symbol facility support

Indicates whether the programmed symbol facility can be used on this 3270 device of SCS printer. The options are PROGSYMBOL or NOPROGSYMBOL .


getPrtcopyst

ITerminal.PrtcopystValue getPrtcopyst()
Getter for field PRTCOPYST

Hardware COPY feature for preferred printer

Indicates whether CICS is to use the hardware COPY feature to satisfy a print request from the preferred printer.

Input Values: PRTCOPY, NOPRTCOPY


getQueryst

ITerminal.QuerystValue getQueryst()
Getter for field QUERYST

Query option

Indicates whether the device supports the use of the QUERY structured field to determine its characteristics:


getRelreqst

ITerminal.RelreqstValue getRelreqst()
Getter for field RELREQST

Release Request status

Indicates whether CICS is to honor release requests from VTAM for the logical unit.

Input Values: RELREQ, NORELREQ, NOTAPPLIC


getSosist

ITerminal.SosistValue getSosist()
Getter for field SOSIST

Mixed EBCDIC/DBCS support

Indicates whether the device supports mixed EBCDIC and double-byte character set (DBCS) fields. The options are SOSI or NOSOSI.


getTextkybdst

ITerminal.TextkybdstValue getTextkybdst()
Getter for field TEXTKYBDST

Text-keyboard feature

Indicates whether the 3270 device has the text keyboard feature. The options are TEXTKYBD or NOTEXTKYBD.


getTextprintst

ITerminal.TextprintstValue getTextprintst()
Getter for field TEXTPRINTST

Text-print feature

Indicates whether a 3288 printer has the text-print feature. The options are TEXTPRINT or NOTEXTPRINT.


getUctranst

ITerminal.UctranstValue getUctranst()
Getter for field UCTRANST

Uppercase translate option support

Indicates whether the upper case translate option is supported for transactions associated with this terminal. The options are UCTRAN, NOUCTRAN, TRANIDONLY.


getValidationst

ITerminal.ValidationstValue getValidationst()
Getter for field VALIDATIONST

Extended validation feature

Indicates whether the device has the extended validation feature. The options are VALIDATION or NOVALIDATION.


getVformst

ITerminal.VformstValue getVformst()
Getter for field VFORMST

Vertical form feature

Indicates whether the device has the vertical form feature, which enables BMS to use vertical tabbing when formatting documents for output (VFORM or NOVFORM).


getAltsuffix

java.lang.String getAltsuffix()
Getter for field ALTSUFFIX

Alternate-map-set suffix

A 1-character numeric suffix that BMS appends to map set names, as specified on the DFHMSD TYPE macro. If this field is blank, it means that no suffix is added to map set names. This applies only when the screen has the alternate size and suffixing is in use.


getStorage

java.lang.Long getStorage()
Getter for field STORAGE

Terminal input-output area (TIOA) storage

The average TIOA storage allowed at this terminal.


getAscii

ITerminal.AsciiValue getAscii()
Getter for field ASCII

ASCII data stream type

Identifies the type of ASCII data stream being used.


getAutoconnect

ITerminal.AutoconnectValue getAutoconnect()
Getter for field AUTOCONNECT

Session binding status

Identifies whether sessions with this terminal are to be established when CICS is initialized or whenever communication with VTAM is started.


getDatastream

ITerminal.DatastreamValue getDatastream()
Getter for field DATASTREAM

Device data stream type

Identifies the device data stream type:


getMapsetname

java.lang.String getMapsetname()
Getter for field MAPSETNAME

Last map set referenced in SEND MAP command

The name of the BMS map set that was most recently referenced in the MAPSET option of a SEND MAP command processed for this terminal.


getMapname

java.lang.String getMapname()
Getter for field MAPNAME

Last map referenced in SEND MAP command

The name of the BMS map that was most recently referenced in the MAP option of a SEND MAP command processed for this terminal.


getCorrelid

java.lang.String getCorrelid()
Getter for field CORRELID

Correlation ID

The 8-character correlation-id, as follows:


getRemotesysnet

java.lang.String getRemotesysnet()
Getter for field REMOTESYSNET

Remote TOR net name

For remote terminals only, the 8-character netname of the owning TOR.


getLinksystem

java.lang.String getLinksystem()
Getter for field LINKSYSTEM

Real link connection for remote TOR

For remote terminals only, the 4-character name of the connection that is the real link towards the TOR.


getConsole

java.lang.String getConsole()
Getter for field CONSOLE

Console ID

Indicates, for an MVS console only, the identifier for the console.


getNqname

java.lang.String getNqname()
Getter for field NQNAME

Network qualified name

The network qualified name if one was sent by VTAM at logon time.



Copyright 2008-2009 IBM Corp. All Rights Reserved.