Interface ITerminal
-
- All Superinterfaces:
ICICSObject,ICICSResource,IInstalledCICSResource,com.ibm.cics.model.meta.ITypedObject
public interface ITerminal extends ICICSResource, IInstalledCICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classITerminal.AccessmethodValueEnumeration type for field ACCESSMETHODstatic classITerminal.AcquireStatusValueEnumeration type for field ACQSTATUSstatic classITerminal.AltprtcopystValueEnumeration type for field ALTPRTCOPYSTstatic classITerminal.AplkybdstValueEnumeration type for field APLKYBDSTstatic classITerminal.ApltextstValueEnumeration type for field APLTEXTSTstatic classITerminal.AsciiValueEnumeration type for field ASCIIstatic classITerminal.ATIStatusValueEnumeration type for field ATISTATUSstatic classITerminal.AudalarmstValueEnumeration type for field AUDALARMSTstatic classITerminal.AutoconnectValueEnumeration type for field AUTOCONNECTstatic classITerminal.BacktransstValueEnumeration type for field BACKTRANSSTstatic classITerminal.ColorstValueEnumeration type for field COLORSTstatic classITerminal.CopystValueEnumeration type for field COPYSTstatic classITerminal.DatastreamValueEnumeration type for field DATASTREAMstatic classITerminal.DeviceValueEnumeration type for field DEVICEstatic classITerminal.DiscreqstValueEnumeration type for field DISCREQSTstatic classITerminal.DualcasestValueEnumeration type for field DUALCASESTstatic classITerminal.ExittracingValueEnumeration type for field EXITTRACINGstatic classITerminal.ExtendeddsstValueEnumeration type for field EXTENDEDDSSTstatic classITerminal.FmhparmstValueEnumeration type for field FMHPARMSTstatic classITerminal.FormfeedstValueEnumeration type for field FORMFEEDSTstatic classITerminal.HformstValueEnumeration type for field HFORMSTstatic classITerminal.HilightstValueEnumeration type for field HILIGHTSTstatic classITerminal.KatakanastValueEnumeration type for field KATAKANASTstatic classITerminal.LightpenstValueEnumeration type for field LIGHTPENSTstatic classITerminal.MsrcontrolstValueEnumeration type for field MSRCONTROLSTstatic classITerminal.NatureValueEnumeration type for field NATUREstatic classITerminal.ObformatstValueEnumeration type for field OBFORMATSTstatic classITerminal.OboperidstValueEnumeration type for field OBOPERIDSTstatic classITerminal.OutlinestValueEnumeration type for field OUTLINESTstatic classITerminal.PagestatusValueEnumeration type for field PAGESTATUSstatic classITerminal.PartitionsstValueEnumeration type for field PARTITIONSSTstatic classITerminal.PrintadaptstValueEnumeration type for field PRINTADAPTSTstatic classITerminal.ProgsymbolstValueEnumeration type for field PROGSYMBOLSTstatic classITerminal.PrtcopystValueEnumeration type for field PRTCOPYSTstatic classITerminal.QuerystValueEnumeration type for field QUERYSTstatic classITerminal.RelreqstValueEnumeration type for field RELREQSTstatic classITerminal.SecurityValueEnumeration type for field SECURITYstatic classITerminal.ServiceStatusValueEnumeration type for field SERVSTATUSstatic classITerminal.SessionStatusValueEnumeration type for field CREATESESSstatic classITerminal.SessiontypeValueEnumeration type for field SESSIONTYPEstatic classITerminal.SignonstatusValueEnumeration type for field SIGNONSTATUSstatic classITerminal.SosistValueEnumeration type for field SOSISTstatic classITerminal.TextkybdstValueEnumeration type for field TEXTKYBDSTstatic classITerminal.TextprintstValueEnumeration type for field TEXTPRINTSTstatic classITerminal.TnipfamilyValueEnumeration type for field TNIPFAMILYstatic classITerminal.TracingValueEnumeration type for field TRACINGstatic classITerminal.TTIStatusValueEnumeration type for field TTISTATUSstatic classITerminal.UctranstValueEnumeration type for field UCTRANSTstatic classITerminal.ValidationstValueEnumeration type for field VALIDATIONSTstatic classITerminal.VformstValueEnumeration type for field VFORMSTstatic classITerminal.ZcptracingValueEnumeration type for field ZCPTRACING
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ITerminal.AccessmethodValuegetAccessmethod()Getter for field ACCESSMETHODITerminal.AcquireStatusValuegetAcquireStatus()Getter for field ACQSTATUSjava.lang.LonggetAltpageht()Getter for field ALTPAGEHTjava.lang.LonggetAltpagewd()Getter for field ALTPAGEWDjava.lang.StringgetAltprinter()Getter for field ALTPRINTERITerminal.AltprtcopystValuegetAltprtcopyst()Getter for field ALTPRTCOPYSTjava.lang.LonggetAltscrnht()Getter for field ALTSCRNHTjava.lang.LonggetAltscrnwd()Getter for field ALTSCRNWDjava.lang.StringgetAltsuffix()Getter for field ALTSUFFIXITerminal.AplkybdstValuegetAplkybdst()Getter for field APLKYBDSTITerminal.ApltextstValuegetApltextst()Getter for field APLTEXTSTITerminal.AsciiValuegetAscii()Getter for field ASCIIITerminal.ATIStatusValuegetATIStatus()Getter for field ATISTATUSITerminal.AudalarmstValuegetAudalarmst()Getter for field AUDALARMSTITerminal.AutoconnectValuegetAutoconnect()Getter for field AUTOCONNECTITerminal.BacktransstValuegetBacktransst()Getter for field BACKTRANSSTITerminalReferencegetCICSObjectReference()ITerminal.ColorstValuegetColorst()Getter for field COLORSTjava.lang.StringgetConsole()Getter for field CONSOLEITerminal.CopystValuegetCopyst()Getter for field COPYSTjava.lang.StringgetCorrelid()Getter for field CORRELIDITerminal.DatastreamValuegetDatastream()Getter for field DATASTREAMjava.lang.LonggetDefpageht()Getter for field DEFPAGEHTjava.lang.LonggetDefpagewd()Getter for field DEFPAGEWDjava.lang.LonggetDefscrnht()Getter for field DEFSCRNHTjava.lang.LonggetDefscrnwd()Getter for field DEFSCRNWDITerminal.DeviceValuegetDevice()Getter for field DEVICEITerminal.DiscreqstValuegetDiscreqst()Getter for field DISCREQSTITerminal.DualcasestValuegetDualcasest()Getter for field DUALCASESTITerminal.ExittracingValuegetExittracing()Getter for field EXITTRACINGITerminal.ExtendeddsstValuegetExtendeddsst()Getter for field EXTENDEDDSSTITerminal.FmhparmstValuegetFmhparmst()Getter for field FMHPARMSTITerminal.FormfeedstValuegetFormfeedst()Getter for field FORMFEEDSTjava.lang.LonggetGchars()Getter for field GCHARSjava.lang.LonggetGcodes()Getter for field GCODESITerminal.HformstValuegetHformst()Getter for field HFORMSTITerminal.HilightstValuegetHilightst()Getter for field HILIGHTSTjava.lang.LonggetInpmsgcnt()Getter for field INPMSGCNTITerminal.KatakanastValuegetKatakanast()Getter for field KATAKANASTITerminal.LightpenstValuegetLightpenst()Getter for field LIGHTPENSTjava.lang.StringgetLinksystem()Getter for field LINKSYSTEMjava.lang.StringgetMapname()Getter for field MAPNAMEjava.lang.StringgetMapsetname()Getter for field MAPSETNAMEjava.lang.StringgetModename()Getter for field MODENAMEITerminal.MsrcontrolstValuegetMsrcontrolst()Getter for field MSRCONTROLSTjava.lang.StringgetName()Getter for field TERMIDjava.lang.StringgetNatlang()Getter for field NATLANGITerminal.NatureValuegetNature()Getter for field NATUREjava.lang.StringgetNetworkName()Getter for field NETNAMEjava.lang.StringgetNexttransid()Getter for field NEXTTRANSIDjava.lang.StringgetNqname()Getter for field NQNAMEITerminal.ObformatstValuegetObformatst()Getter for field OBFORMATSTICICSType<ITerminal>getObjectType()ITerminal.OboperidstValuegetOboperidst()Getter for field OBOPERIDSTjava.lang.StringgetOperid()Getter for field OPERIDITerminal.OutlinestValuegetOutlinest()Getter for field OUTLINESTjava.lang.LonggetOutmsgcnt()Getter for field OUTMSGCNTjava.lang.LonggetPageht()Getter for field PAGEHTITerminal.PagestatusValuegetPagestatus()Getter for field PAGESTATUSjava.lang.LonggetPagewd()Getter for field PAGEWDITerminal.PartitionsstValuegetPartitionsst()Getter for field PARTITIONSSTjava.lang.LonggetPmsgcnt()Getter for field PMSGCNTjava.lang.LonggetPmsgconsec()Getter for field PMSGCONSECjava.lang.LonggetPmsggrpcnt()Getter for field PMSGGRPCNTjava.lang.StringgetPollcnt()Getter for field POLLCNTITerminal.PrintadaptstValuegetPrintadaptst()Getter for field PRINTADAPTSTjava.lang.StringgetPrinter()Getter for field PRINTERITerminal.ProgsymbolstValuegetProgsymbolst()Getter for field PROGSYMBOLSTITerminal.PrtcopystValuegetPrtcopyst()Getter for field PRTCOPYSTITerminal.QuerystValuegetQueryst()Getter for field QUERYSTITerminal.RelreqstValuegetRelreqst()Getter for field RELREQSTjava.lang.StringgetRemotename()Getter for field REMOTENAMEjava.lang.StringgetRemotesysnet()Getter for field REMOTESYSNETjava.lang.StringgetRemotesystem()Getter for field REMOTESYSTEMjava.lang.LonggetScreenheight()Getter for field SCREENHEIGHTjava.lang.LonggetScreenwidth()Getter for field SCREENWIDTHITerminal.SecurityValuegetSecurity()Getter for field SECURITYITerminal.ServiceStatusValuegetServiceStatus()Getter for field SERVSTATUSITerminal.SessionStatusValuegetSessionStatus()Getter for field CREATESESSITerminal.SessiontypeValuegetSessiontype()Getter for field SESSIONTYPEITerminal.SignonstatusValuegetSignonstatus()Getter for field SIGNONSTATUSITerminal.SosistValuegetSosist()Getter for field SOSISTjava.lang.LonggetStgvcnt()Getter for field STGVCNTjava.lang.LonggetStorage()Getter for field STORAGEjava.lang.LonggetTaskID()Getter for field TASKIDjava.lang.StringgetTcamcontrol()Getter for field TCAMCONTROLjava.lang.LonggetTermmodel()Getter for field TERMMODELjava.lang.LonggetTermpriority()Getter for field TERMPRIORITYjava.lang.LonggetTermtype()Getter for field TERMTYPEjava.lang.LonggetTerrcnt()Getter for field TERRCNTITerminal.TextkybdstValuegetTextkybdst()Getter for field TEXTKYBDSTITerminal.TextprintstValuegetTextprintst()Getter for field TEXTPRINTSTjava.lang.StringgetTnaddr()Getter for field TNADDRjava.lang.StringgetTnhost()Getter for field TNHOSTITerminal.TnipfamilyValuegetTnipfamily()Getter for field TNIPFAMILYjava.lang.LonggetTnport()Getter for field TNPORTITerminal.TracingValuegetTracing()Getter for field TRACINGjava.lang.LonggetTrancnt()Getter for field TRANCNTjava.lang.StringgetTransactionID()Getter for field TRANSACTIONITerminal.TTIStatusValuegetTTIStatus()Getter for field TTISTATUSITerminal.UctranstValuegetUctranst()Getter for field UCTRANSTjava.lang.StringgetUserarea()Getter for field USERAREAjava.lang.LonggetUserarealen()Getter for field USERAREALENjava.lang.StringgetUserID()Getter for field USERIDjava.lang.StringgetUsername()Getter for field USERNAMEITerminal.ValidationstValuegetValidationst()Getter for field VALIDATIONSTITerminal.VformstValuegetVformst()Getter for field VFORMSTjava.lang.LonggetXerrcnt()Getter for field XERRCNTITerminal.ZcptracingValuegetZcptracing()Getter for field ZCPTRACING-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ITerminal> getObjectType()
- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field TERMIDTerminal ID
The terminal name as specified in the installed terminal definition.
- Specified by:
getNamein interfaceICICSObject
-
getAcquireStatus
ITerminal.AcquireStatusValue getAcquireStatus()
Getter for field ACQSTATUSAcquire 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:
- ACQUIRED
- RELEASED
- NOTAPPLIC
- COLDACQ
- ACQUIRING
- RELEASING
-
getATIStatus
ITerminal.ATIStatusValue getATIStatus()
Getter for field ATISTATUSAutomatic 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 CREATESESSSession 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 ACCESSMETHODAccess method
The access method defined for the terminal as one of the following:
- VTAM
- BSAM
- BTAM
- BGAM
- TCAM
- TCAMSNA
- CONSOLE
-
getSecurity
ITerminal.SecurityValue getSecurity()
Getter for field SECURITYPreset security status
Indicates whether the terminal has preset security (PRESET or NOPRESET).
-
getDevice
ITerminal.DeviceValue getDevice()
Getter for field DEVICEDevice 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 EXITTRACINGExit 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 GCHARSGraphic 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 GCODESCode 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 MODENAMEMode name
Under APPC, the name of a group of parallel sessions (to which this terminal belongs) that have similar characteristics.
-
getNature
ITerminal.NatureValue getNature()
Getter for field NATURETerminal definition type
Indicates the nature of the terminal definition as one of the following:
- TERMINAL - Physical terminal definition
- MODEL - Model terminal definition, specific to a type of terminal
- SESSION - Remote (APPC) session
- SURROGAT - Surrogate terminal definition
- REMSESSION - A remote session
-
getNatlang
java.lang.String getNatlang()
Getter for field NATLANGNational 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 NETNAMENetwork 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 OPERIDOperator 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 PAGESTATUSBMS 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 SCREENHEIGHTScreen height
The height of the current 3270 screen, which is either the ALTSCRNHT or DEFSCRNHT value.
-
getScreenwidth
java.lang.Long getScreenwidth()
Getter for field SCREENWIDTHScreen width
The width of the current 3270 screen, which is either the ALTSCRNWD or DEFSCRNWD value.
-
getServiceStatus
ITerminal.ServiceStatusValue getServiceStatus()
Getter for field SERVSTATUSService 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 SIGNONSTATUSSign-on status
Indicates whether the terminal currently has a signed on user (SIGNEDON or SIGNEDOFF).
-
getTaskID
java.lang.Long getTaskID()
Getter for field TASKIDId 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 TERMPRIORITYTerminal priority
The priority of the terminal relative to other terminals.
Input Values: 0 - 255.
-
getTracing
ITerminal.TracingValue getTracing()
Getter for field TRACINGTerminal 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 TRANSACTIONCurrent transaction name
The name of the transaction currently executing with this terminal as its principal facility.
-
getTTIStatus
ITerminal.TTIStatusValue getTTIStatus()
Getter for field TTISTATUSTerminal 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 USERAREATerminal user area (TCTUA) address
The address of the user area.
-
getTermmodel
java.lang.Long getTermmodel()
Getter for field TERMMODELTerminal 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 USERAREALENTerminal user area (TCTUA) length
The length of the user area.
-
getUserID
java.lang.String getUserID()
Getter for field USERIDUser 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 ZCPTRACINGZCP 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 NEXTTRANSIDNext 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 SESSIONTYPESession type
For terminals that are acting as sessions with another CICS system, the type of session as one of the following:
- LU61 - An LUTYPE6.1 session.
- APPCSINGLE - A single APPC session.
- APPCPARALLEL - A parallel APPC session group.
- NOTAPPLIC - The terminal is not one of the above.
-
getUsername
java.lang.String getUsername()
Getter for field USERNAMEUser 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 REMOTENAMEName 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 REMOTESYSTEMRemote 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 POLLCNTNumber 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 INPMSGCNTNumber 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 OUTMSGCNTNumber 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 TRANCNTNumber of transactions
The number of transactions, both nonconversational and pseudoconversational, that were started at the terminal.
-
getStgvcnt
java.lang.Long getStgvcnt()
Getter for field STGVCNTNumber of storage violations
The number of storage violations that have occurred on the terminal.
-
getXerrcnt
java.lang.Long getXerrcnt()
Getter for field XERRCNTNumber 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 TERRCNTNumber of transaction errors
The number of transactions associated with the terminal that could not be started.
-
getPmsgcnt
java.lang.Long getPmsgcnt()
Getter for field PMSGCNTTotal 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 PMSGGRPCNTNumber 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 PMSGCONSECMaximum 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 TERMTYPETerminal type
The type of terminal.
-
getTcamcontrol
java.lang.String getTcamcontrol()
Getter for field TCAMCONTROLTCAM 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:
- 00 Null
- 40 Intermediate part of message
- F1 First part of message
- F2 Last part of message
- F3 Whole message
- F4 Intermediate part of message, end of record
- F5 First part of message, end of record
- F6 Last part of message, end of record
- F7 Whole message, end of record
- FE TCAM is not active
- FF Not applicable (non-TCAM terminal)
-
getAltpageht
java.lang.Long getAltpageht()
Getter for field ALTPAGEHTAlternate 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 ALTPAGEWDAlternate 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 ALTPRINTERAlternate printer
The name of a 3270 printer for use as an alternative to the preferred printer.
-
getAltprtcopyst
ITerminal.AltprtcopystValue getAltprtcopyst()
Getter for field ALTPRTCOPYSTHardware 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 ALTSCRNHTAlternate 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 ALTSCRNWDAlternate 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 APLKYBDSTAPL keyboard feature
Indicates whether the 3270 device has the APL keyboard feature. Values are APLKYBDS or NOAPLKYB.
-
getApltextst
ITerminal.ApltextstValue getApltextst()
Getter for field APLTEXTSTAPL text feature
Indicates whether the 3270 device has the APL text feature. Values are APLTEXT or NOAPLTEX.
-
getAudalarmst
ITerminal.AudalarmstValue getAudalarmst()
Getter for field AUDALARMSTAudible 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 BACKTRANSSTBackground transparency feature
Indicates whether the device has the background transparency feature (BACKTRANS or NOBACKTRANS).
-
getColorst
ITerminal.ColorstValue getColorst()
Getter for field COLORSTExtended 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 COPYSTCopy 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 DEFPAGEHTDefault 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 DEFPAGEWDDefault 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 DEFSCRNHTDefault 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 DEFSCRNWDDefault 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 DISCREQSTDisconnect 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 DUALCASESTDual-case keyboard status
Indicates whether the terminal has a typewriter keyboard or an operator console keyboard. Values are:
- DUALCASE - The terminal has a typewriter keyboard.
- NODUALCASE - The terminal has an operator console keyboard (this keyboard is not restricted to a single case), or is not a 3270 display.
-
getExtendeddsst
ITerminal.ExtendeddsstValue getExtendeddsst()
Getter for field EXTENDEDDSSTExtended 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 FMHPARMSTFunction 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 FORMFEEDSTForms feed feature
Indicates whether the device has the forms feed feature. The options are FORMFEED and NOFORMFEED.
-
getHilightst
ITerminal.HilightstValue getHilightst()
Getter for field HILIGHTSTExtended 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 HFORMSTHorizontal 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 KATAKANASTKatakana terminal
Indicates whether the device is a Katakana terminal (KATAKANA or NOKATAKANA).
-
getLightpenst
ITerminal.LightpenstValue getLightpenst()
Getter for field LIGHTPENSTSelector 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 MSRCONTROLSTMagnetic 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 OBFORMATSTOutboard formatting support
Indicates whether the device supports outboard formatting.
Input Values: OBFORMAT, NOOBFORMAT
-
getOboperidst
ITerminal.OboperidstValue getOboperidst()
Getter for field OBOPERIDSTOutboard 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 OUTLINESTField outlining support
Indicates whether the device supports field outlining. The options are OUTLINE or NOOUTLINE.
-
getPageht
java.lang.Long getPageht()
Getter for field PAGEHTCurrent page height
The page height currently in use for the device.
-
getPagewd
java.lang.Long getPagewd()
Getter for field PAGEWDCurrent page width
The page width currently in use for the device.
-
getPartitionsst
ITerminal.PartitionsstValue getPartitionsst()
Getter for field PARTITIONSSTPartitions status
Indicates whether the device can use partitions (PARTITIONS or NOPARTITIONS).
-
getPrintadaptst
ITerminal.PrintadaptstValue getPrintadaptst()
Getter for field PRINTADAPTSTPrinter adaptor feature
Indicates whether the device supports a printer adaptor feature (PRINTADAPT or NOPRINTADAPT).
-
getPrinter
java.lang.String getPrinter()
Getter for field PRINTERPrinter 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 PROGSYMBOLSTProgrammed 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 PRTCOPYSTHardware 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 QUERYSTQuery option
Indicates whether the device supports the use of the QUERY structured field to determine its characteristics:
- ALLQUERY - The QUERY function is supported each time the device is connected.
- COLDQUERY - The QUERY function is supported only when the device is first connected after a cold start of CICS.
- NOQUERY - The QUERY function is not supported.
-
getRelreqst
ITerminal.RelreqstValue getRelreqst()
Getter for field RELREQSTRelease 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 SOSISTMixed 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 TEXTKYBDSTText-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 TEXTPRINTSTText-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 UCTRANSTUppercase 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 VALIDATIONSTExtended validation feature
Indicates whether the device has the extended validation feature. The options are VALIDATION or NOVALIDATION.
-
getVformst
ITerminal.VformstValue getVformst()
Getter for field VFORMSTVertical 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 ALTSUFFIXAlternate-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 STORAGETerminal input-output area (TIOA) storage
The average TIOA storage allowed at this terminal.
-
getAscii
ITerminal.AsciiValue getAscii()
Getter for field ASCIIASCII data stream type
Identifies the type of ASCII data stream being used.
- ASCII7 - A 7-bit ASCII datastream.
- ASCII8 - An 8-bit ASCII datastream.
- NOTAPPLIC - Not applicable.
-
getAutoconnect
ITerminal.AutoconnectValue getAutoconnect()
Getter for field AUTOCONNECTSession binding status
Identifies whether sessions with this terminal are to be established when CICS is initialized or whenever communication with VTAM is started.
- ALLCONN - Same as AUTOCONN
- AUTOCONN - CICS binds associated sessions.
- NONAUTOCONN - CICS does not bind associated sessions.
- NOTAPPLIC - The terminal is not a VTAM terminal, or is a remote terminal, a surrogate, or a model.
-
getDatastream
ITerminal.DatastreamValue getDatastream()
Getter for field DATASTREAMDevice data stream type
Identifies the device data stream type:
- DS3270 - 3270 Datastream
- NOTAPPLIC - Not applicable
- SCS - SNA character strings
-
getMapsetname
java.lang.String getMapsetname()
Getter for field MAPSETNAMELast 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 MAPNAMELast 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 CORRELIDCorrelation ID
The 8-character correlation-id, as follows:
- For LU6.1 sessions, NETNAMEQ.
- .For LU6.2 sessions, a token that is common to the two connected sessions.
- .For MRO sessions, the terminal ID of the session at the other end of the MRO link to which this session is connected.
-
getRemotesysnet
java.lang.String getRemotesysnet()
Getter for field REMOTESYSNETRemote TOR net name
For remote terminals only, the 8-character netname of the owning TOR.
-
getLinksystem
java.lang.String getLinksystem()
Getter for field LINKSYSTEMReal 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 CONSOLEConsole ID
Indicates, for an MVS console only, the identifier for the console.
-
getNqname
java.lang.String getNqname()
Getter for field NQNAMENetwork qualified name
The network qualified name if one was sent by VTAM at logon time.
-
getTnaddr
java.lang.String getTnaddr()
Getter for field TNADDRClient TN3270 IPv4 or IPv6 address.
The client TN3270 IPv4 or IPv6 address. If TNIPFAMILY returns NOTAPPLIC, TNADDR returns blanks.
-
getTnipfamily
ITerminal.TnipfamilyValue getTnipfamily()
Getter for field TNIPFAMILYAddress format of the TNADDR option
Identifies the address format of the TNADDR option.
- IPV4 - a dotted decimal IPv4 address.
- IPV6 - a colon hexadecimal IPv6 address.
- NOTAPPLIC - Not applicable.
-
getTnport
java.lang.Long getTnport()
Getter for field TNPORTPort number
The port number used for a TN3270 client connection. If the terminal is not a 3270 device, TNPORT returns zero.
-
getTnhost
java.lang.String getTnhost()
Getter for field TNHOSTHost name
The hostname used by the TN3270 client connection.
-
getCICSObjectReference
ITerminalReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICICSResource
-
-