Interface ITypetermDefinition
-
- All Superinterfaces:
ICICSDefinition
,ICICSObject
,IDefinition
,com.ibm.cics.model.meta.ITypedObject
public interface ITypetermDefinition extends ICICSDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ITypetermDefinition.AplkybdValue
Enumeration type for field APLKYBDstatic class
ITypetermDefinition.ApltextValue
Enumeration type for field APLTEXTstatic interface
ITypetermDefinition.AsciiValue
Long constants interface for field ASCIIstatic class
ITypetermDefinition.AtiValue
Enumeration type for field ATIstatic class
ITypetermDefinition.AudiblealarmValue
Enumeration type for field AUDIBLEALARMstatic class
ITypetermDefinition.AutoconnectValue
Enumeration type for field AUTOCONNECTstatic class
ITypetermDefinition.AutopageValue
Enumeration type for field AUTOPAGEstatic class
ITypetermDefinition.BacktransValue
Enumeration type for field BACKTRANSstatic class
ITypetermDefinition.BracketValue
Enumeration type for field BRACKETstatic class
ITypetermDefinition.BuildchainValue
Enumeration type for field BUILDCHAINstatic class
ITypetermDefinition.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
ITypetermDefinition.ColorValue
Enumeration type for field COLORstatic class
ITypetermDefinition.CopyValue
Enumeration type for field COPYstatic class
ITypetermDefinition.CreatesessValue
Enumeration type for field CREATESESSstatic class
ITypetermDefinition.DiscreqValue
Enumeration type for field DISCREQstatic class
ITypetermDefinition.DualcasekybdValue
Enumeration type for field DUALCASEKYBDstatic class
ITypetermDefinition.ErrcolorValue
Enumeration type for field ERRCOLORstatic class
ITypetermDefinition.ErrhilightValue
Enumeration type for field ERRHILIGHTstatic class
ITypetermDefinition.ErrintensifyValue
Enumeration type for field ERRINTENSIFYstatic class
ITypetermDefinition.ErrlastlineValue
Enumeration type for field ERRLASTLINEstatic class
ITypetermDefinition.ExtendeddsValue
Enumeration type for field EXTENDEDDSstatic class
ITypetermDefinition.FmhparmValue
Enumeration type for field FMHPARMstatic class
ITypetermDefinition.FormfeedValue
Enumeration type for field FORMFEEDstatic class
ITypetermDefinition.HilightValue
Enumeration type for field HILIGHTstatic class
ITypetermDefinition.HorizformValue
Enumeration type for field HORIZFORMstatic class
ITypetermDefinition.KatakanaValue
Enumeration type for field KATAKANAstatic class
ITypetermDefinition.LightpenValue
Enumeration type for field LIGHTPENstatic class
ITypetermDefinition.LogonmsgValue
Enumeration type for field LOGONMSGstatic class
ITypetermDefinition.MsrcontrolValue
Enumeration type for field MSRCONTROLstatic class
ITypetermDefinition.ObformatValue
Enumeration type for field OBFORMATstatic class
ITypetermDefinition.OboperidValue
Enumeration type for field OBOPERIDstatic class
ITypetermDefinition.OutlineValue
Enumeration type for field OUTLINEstatic class
ITypetermDefinition.PartitionsValue
Enumeration type for field PARTITIONSstatic class
ITypetermDefinition.PrintadapterValue
Enumeration type for field PRINTADAPTERstatic class
ITypetermDefinition.ProgsymbolsValue
Enumeration type for field PROGSYMBOLSstatic class
ITypetermDefinition.QueryValue
Enumeration type for field QUERYstatic class
ITypetermDefinition.RecovnotifyValue
Enumeration type for field RECOVNOTIFYstatic class
ITypetermDefinition.RecovoptionValue
Enumeration type for field RECOVOPTIONstatic class
ITypetermDefinition.RelreqValue
Enumeration type for field RELREQstatic class
ITypetermDefinition.RoutedmsgsValue
Enumeration type for field ROUTEDMSGSstatic class
ITypetermDefinition.RstsignoffValue
Enumeration type for field RSTSIGNOFFstatic class
ITypetermDefinition.ShippableValue
Enumeration type for field SHIPPABLEstatic class
ITypetermDefinition.SignoffValue
Enumeration type for field SIGNOFFstatic class
ITypetermDefinition.SosiValue
Enumeration type for field SOSIstatic class
ITypetermDefinition.TextkybdValue
Enumeration type for field TEXTKYBDstatic class
ITypetermDefinition.TextprintValue
Enumeration type for field TEXTPRINTstatic class
ITypetermDefinition.TtiValue
Enumeration type for field TTIstatic class
ITypetermDefinition.UctranValue
Enumeration type for field UCTRANstatic class
ITypetermDefinition.ValidationValue
Enumeration type for field VALIDATIONstatic class
ITypetermDefinition.VerticalformValue
Enumeration type for field VERTICALFORM
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Long
getAltpagecol()
Getter for field ALTPAGECOLjava.lang.Long
getAltpagerow()
Getter for field ALTPAGEROWjava.lang.Long
getAltscreencol()
Getter for field ALTSCREENCOLjava.lang.Long
getAltscreenrow()
Getter for field ALTSCREENROWjava.lang.String
getAltsuffix()
Getter for field ALTSUFFIXITypetermDefinition.AplkybdValue
getAplkybd()
Getter for field APLKYBDITypetermDefinition.ApltextValue
getApltext()
Getter for field APLTEXTjava.lang.Long
getAscii()
Getter for field ASCIIITypetermDefinition.AtiValue
getAti()
Getter for field ATIITypetermDefinition.AudiblealarmValue
getAudiblealarm()
Getter for field AUDIBLEALARMITypetermDefinition.AutoconnectValue
getAutoconnect()
Getter for field AUTOCONNECTITypetermDefinition.AutopageValue
getAutopage()
Getter for field AUTOPAGEITypetermDefinition.BacktransValue
getBacktrans()
Getter for field BACKTRANSITypetermDefinition.BracketValue
getBracket()
Getter for field BRACKETITypetermDefinition.BuildchainValue
getBuildchain()
Getter for field BUILDCHAINjava.lang.Long
getCgcsgidcode()
Getter for field CGCSGIDCODEjava.lang.Long
getCgcsgidgblid()
Getter for field CGCSGIDGBLIDITypetermDefinition.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTICICSDefinitionReference<ITypetermDefinition>
getCICSObjectReference()
ITypetermDefinition.ColorValue
getColor()
Getter for field COLORITypetermDefinition.CopyValue
getCopy()
Getter for field COPYITypetermDefinition.CreatesessValue
getCreatesess()
Getter for field CREATESESSjava.lang.Long
getDefscreencol()
Getter for field DEFSCREENCOLjava.lang.Long
getDefscreenrow()
Getter for field DEFSCREENROWjava.lang.String
getDevice()
Getter for field DEVICEITypetermDefinition.DiscreqValue
getDiscreq()
Getter for field DISCREQITypetermDefinition.DualcasekybdValue
getDualcasekybd()
Getter for field DUALCASEKYBDITypetermDefinition.ErrcolorValue
getErrcolor()
Getter for field ERRCOLORITypetermDefinition.ErrhilightValue
getErrhilight()
Getter for field ERRHILIGHTITypetermDefinition.ErrintensifyValue
getErrintensify()
Getter for field ERRINTENSIFYITypetermDefinition.ErrlastlineValue
getErrlastline()
Getter for field ERRLASTLINEITypetermDefinition.ExtendeddsValue
getExtendedds()
Getter for field EXTENDEDDSITypetermDefinition.FmhparmValue
getFmhparm()
Getter for field FMHPARMITypetermDefinition.FormfeedValue
getFormfeed()
Getter for field FORMFEEDITypetermDefinition.HilightValue
getHilight()
Getter for field HILIGHTITypetermDefinition.HorizformValue
getHorizform()
Getter for field HORIZFORMjava.lang.Long
getIoarealen()
Getter for field IOAREALENjava.lang.Long
getIoarealenalt()
Getter for field IOAREALENALTITypetermDefinition.KatakanaValue
getKatakana()
Getter for field KATAKANAjava.lang.String
getLdclist()
Getter for field LDCLISTITypetermDefinition.LightpenValue
getLightpen()
Getter for field LIGHTPENjava.lang.String
getLogmode()
Getter for field LOGMODEITypetermDefinition.LogonmsgValue
getLogonmsg()
Getter for field LOGONMSGITypetermDefinition.MsrcontrolValue
getMsrcontrol()
Getter for field MSRCONTROLjava.lang.Long
getNepclass()
Getter for field NEPCLASSITypetermDefinition.ObformatValue
getObformat()
Getter for field OBFORMATICICSType<ITypetermDefinition>
getObjectType()
ITypetermDefinition.OboperidValue
getOboperid()
Getter for field OBOPERIDITypetermDefinition.OutlineValue
getOutline()
Getter for field OUTLINEjava.lang.Long
getPagesizecol()
Getter for field PAGESIZECOLjava.lang.Long
getPagesizerow()
Getter for field PAGESIZEROWITypetermDefinition.PartitionsValue
getPartitions()
Getter for field PARTITIONSITypetermDefinition.PrintadapterValue
getPrintadapter()
Getter for field PRINTADAPTERITypetermDefinition.ProgsymbolsValue
getProgsymbols()
Getter for field PROGSYMBOLSITypetermDefinition.QueryValue
getQuery()
Getter for field QUERYjava.lang.Long
getReceivesize()
Getter for field RECEIVESIZEITypetermDefinition.RecovnotifyValue
getRecovnotify()
Getter for field RECOVNOTIFYITypetermDefinition.RecovoptionValue
getRecovoption()
Getter for field RECOVOPTIONITypetermDefinition.RelreqValue
getRelreq()
Getter for field RELREQITypetermDefinition.RoutedmsgsValue
getRoutedmsgs()
Getter for field ROUTEDMSGSITypetermDefinition.RstsignoffValue
getRstsignoff()
Getter for field RSTSIGNOFFjava.lang.Long
getSendsize()
Getter for field SENDSIZEjava.lang.String
getSessiontype()
Getter for field SESSIONTYPEITypetermDefinition.ShippableValue
getShippable()
Getter for field SHIPPABLEITypetermDefinition.SignoffValue
getSignoff()
Getter for field SIGNOFFITypetermDefinition.SosiValue
getSosi()
Getter for field SOSIjava.lang.Long
getTermmodel()
Getter for field TERMMODELITypetermDefinition.TextkybdValue
getTextkybd()
Getter for field TEXTKYBDITypetermDefinition.TextprintValue
getTextprint()
Getter for field TEXTPRINTITypetermDefinition.TtiValue
getTti()
Getter for field TTIITypetermDefinition.UctranValue
getUctran()
Getter for field UCTRANjava.lang.Long
getUserarealen()
Getter for field USERAREALENjava.lang.String
getUserdata1()
Getter for field USERDATA1java.lang.String
getUserdata2()
Getter for field USERDATA2java.lang.String
getUserdata3()
Getter for field USERDATA3ITypetermDefinition.ValidationValue
getValidation()
Getter for field VALIDATIONITypetermDefinition.VerticalformValue
getVerticalform()
Getter for field VERTICALFORM-
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgentRelease, getChangeTime, getChangeUserID, getCICSContainer, getCreateTime, getCSDGroup, getDescription, getVersion
-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ITypetermDefinition> getObjectType()
- Specified by:
getObjectType
in interfaceICICSDefinition
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceIDefinition
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
ITypetermDefinition.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CSDBATCH - The resource was last changed by a DFHCSDUP job.
- DREPAPI - Resource was last changed by a CICSPlex SM API command.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getAltpagecol
java.lang.Long getAltpagecol()
Getter for field ALTPAGECOLAlternate BMS page size (number of columns)
The number of columns for the page size to be used by BMS for this type of device when ALTSCREEN has been selected as the screen size. The default is the PAGESIZE. Both the rows and columns values must each be in the range 0 through 255. In addition, if the product of rows and columns value exceeds 32767 then CICS will reject any attempt to install this TYPTMDEF. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
You will get unexpected results if the columns value of ALTPAGE is different from that of ALTSCREEN.
-
getAltpagerow
java.lang.Long getAltpagerow()
Getter for field ALTPAGEROWAlternate BMS page size (number of rows)
The number of rows for the page size to be used by BMS for this type of device when ALTSCREEN has been selected as the screen size. The default is the PAGESIZE. Both the rows and columns values must each be in the range 0 through 255. In addition, if the product of rows and columns value exceeds 32767 then CICS will reject any attempt to install this TYPTMDEF. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
Note that the rows value of ALTPAGE can usefully be less than that of ALTSCREEN - perhaps to reserve the bottom line of the screen for error messages.
-
getAltscreencol
java.lang.Long getAltscreencol()
Getter for field ALTSCREENCOLAlternate screen size (number of columns)
The number of columns for the alternate 3270 screen size to be used on this type of device when attached to a transaction, for which the default screen size has been specified in an associated profile definition (PROFDEF). Both the rows and columns values must each be in the range 0 through 255. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
-
getAltscreenrow
java.lang.Long getAltscreenrow()
Getter for field ALTSCREENROWAlternate screen size (number of rows)
The number of rows for the alternate 3270 screen size to be used on this type of device when attached to a transaction, for which the default screen size has been specified in an associated profile definition (PROFDEF). Both the rows and columns values must each be in the range 0 through 255. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
-
getAplkybd
ITypetermDefinition.AplkybdValue getAplkybd()
Getter for field APLKYBDAPL keyboard feature
Specifies whether the 3270 device has the APL keyboard feature.
-
getApltext
ITypetermDefinition.ApltextValue getApltext()
Getter for field APLTEXTAPL text feature
Specifies whether the 3270 device has the APL text feature.
-
getAscii
java.lang.Long getAscii()
Getter for field ASCIIASCII feature
Specifies whether the terminal has an ASCII feature:
- NO - This terminal does not have an ASCII feature.
- 7 - Specify this to communicate with ASCII-7 terminals. Devices configured with the
ASCII-7 feature must be LUTYPE2 or LUTYPE3 without extended 3270 features. Only the following
devices are supported: 3274 Model 1C and 51C, 3276 Model 12, 3278, 3287,
Any terminal configured with the ASCII-7 option has all FM data outbound from CICS converted to ASCII-7, and all FM data inbound to CICS converted to EBCDIC. Only FM request data is translated. All other data in the RU such as LU status or sense data is assumed to be in EBCDIC on output. ASCII-7 does not support data streams that contain extended attributes, such as structured fields and function management headers. The ASCII-7 support is available on 3274-1C as an option on the configuration of the standard microcode. The use of the ASCII-7 option is determined at session initiation by BIND parameters set by CICS as a result of the TCT definition described above.
- 8 - Specify this to communicate with ASCII-8 terminals. Devices configured with the
ASCII-8 feature can be LUTYPE1, LUTYPE2, or LUTYPE3 with or without extended 3270 and SCS
data stream features. Any terminal configured with the ASCII-8 option has all FM data
outbound from CICS converted to ASCII-8, and all FM data inbound to CICS converted to EBCDIC.
All FM request data is translated. This includes the AID, cursor address, FM headers and
structured fields. Any other form of the RU such as LU status or sense data is assumed to be
in EBCDIC on input and is transmitted in EBCDIC on output.
ASCII-8 support is intended only for devices that operate in EBCDIC but translate or retranslate the data stream to or from ASCII-8, as is done by this CICS support. This is because the data stream is treated as a character string, and any binary number fields are translated byte by byte as though they were graphic characters. Thus they may not represent their true value while in ASCII form. The ASCII-8 support is available as a microcode RPQ on the 3274 and is mutually exclusive with the ASCII-7 option. The use of the ASCII-8 option is determined at session initiation by BIND parameters set by CICS as a result of the TCT definitions described above.
-
getAti
ITypetermDefinition.AtiValue getAti()
Getter for field ATIAutomatic transaction initiation option
Specifies whether transactions can start at the terminal by automatic transaction initiation.
-
getAudiblealarm
ITypetermDefinition.AudiblealarmValue getAudiblealarm()
Getter for field AUDIBLEALARMAudible alarm feature
Specifies whether the audible alarm feature is installed for a 3270 display or for a 3270 printer attached to a 3651 controller.
-
getAutoconnect
ITypetermDefinition.AutoconnectValue getAutoconnect()
Getter for field AUTOCONNECTAutoconnect for terminal option
Specifies whether autoconnect processing is to occur for the terminal. YES or ALL specifies that the session with the terminal is to be established (that is, BIND is to be performed) during CICS initialization, or when communication with VTAM is started using the CEMT SET VTAM OPEN command. If you use the VTAM LOGAPPL function, do not specify YES, because this can lead to race conditions causing errors or hung logical units.
- NO - CICS does not attempt to bind sessions when the connection is established.
- YES - CICS attempts to bind as a contention winner session, when the connection is established.
- ALL - Not applicable.
-
getAutopage
ITypetermDefinition.AutopageValue getAutopage()
Getter for field AUTOPAGEBMS autopaging option
Specifies whether BMS autopaging is to be used. Specify YES for printers and NO for display devices.
-
getBacktrans
ITypetermDefinition.BacktransValue getBacktrans()
Getter for field BACKTRANSBackground transparency option
Specifies whether the device has the background transparency feature.
-
getBracket
ITypetermDefinition.BracketValue getBracket()
Getter for field BRACKETBracket protocol enforced
Specifies whether bracket protocol is to be enforced for this logical unit.
-
getBuildchain
ITypetermDefinition.BuildchainValue getBuildchain()
Getter for field BUILDCHAINCICS chain assembly performed
Specifies whether CICS is to perform chain assembly prior to passing the input data to the application program:
- NO - Any terminal input/output area (TIOA) received by an application program from this logical unit contains one request unit (RU).
- YES - Any TIOA received by an application program from this logical unit contains a complete chain.
-
getCgcsgidcode
java.lang.Long getCgcsgidcode()
Getter for field CGCSGIDCODEGraphic character set global code
The graphic character set global code.
-
getCgcsgidgblid
java.lang.Long getCgcsgidgblid()
Getter for field CGCSGIDGBLIDGraphic character set global ID
The coded graphic character set global identifier (CGCSGID) enables application programs to determine the character set supported at the device. You can get this information from a QUERY structured field for some devices. For others, you must supply this information here, so that application programs can retrieve it using the EXEC CICS ASSIGN command.
- 0,0 - No CGCSGID is specified.
- gcsid,cpgid - The CGCSGID consists of two 5-digit decimal numbers which can take values in the range 1 through 65535. gcsid is the graphic character set global identifier (GCSGID) and cpgid is a specification of the code points for the set, the code page global identifier (CPGID).
-
getColor
ITypetermDefinition.ColorValue getColor()
Getter for field COLORExtended color feature
Specifies whether the 3270 device or the SCS printer has the extended color feature, which allows colors to be selected for each field or character.
-
getCopy
ITypetermDefinition.CopyValue getCopy()
Getter for field COPYCopy feature
Specifies whether the copy feature for a 3270 display or printer is included in the 3270 control unit.
-
getCreatesess
ITypetermDefinition.CreatesessValue getCreatesess()
Getter for field CREATESESSSessions to be created
Specifies whether sessions are to be created:
- NO - Specify this to prevent internally generated session requests from actually creating a session.
- YES - Specify this for a status that allows internally generated session requests to create a session.
-
getDefscreencol
java.lang.Long getDefscreencol()
Getter for field DEFSCREENCOLDefault screen size (number of columns)
The number of columns for the 3270 screen size (or 3270 printer page size) to be used on this type of device when attached to a transaction, for which the default screen size has been specified in an associated profile definition (PROFDEF). Both the rows and columns values must each be in the range 0 through 255. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
-
getDefscreenrow
java.lang.Long getDefscreenrow()
Getter for field DEFSCREENROWDefault screen size (number of rows)
The number of rows for the 3270 screen size (or 3270 printer page size) to be used on this type of device when attached to a transaction, for which the default screen size has been specified in an associated profile definition (PROFDEF). Both the rows and columns values must each be in the range 0 through 255. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
-
getDevice
java.lang.String getDevice()
Getter for field DEVICEDevice type
The device type which this TYPETERM defines.
-
getDiscreq
ITypetermDefinition.DiscreqValue getDiscreq()
Getter for field DISCREQDisconnect requests honored
Specifies whether disconnect requests for VTAM devices are to be honored.
-
getDualcasekybd
ITypetermDefinition.DualcasekybdValue getDualcasekybd()
Getter for field DUALCASEKYBDDual case keyboard supported
Specifies whether a 3270 display has a typewriter keyboard or an operator console keyboard. Both uppercase and lowercase data can be transmitted with either of these keyboards
-
getErrcolor
ITypetermDefinition.ErrcolorValue getErrcolor()
Getter for field ERRCOLORColor of error messages
Specifies whether the error message is to be displayed in color. The colors you can specify are: blue, red, pink, green, turquoise, yellow, and neutral.
-
getErrhilight
ITypetermDefinition.ErrhilightValue getErrhilight()
Getter for field ERRHILIGHTError messages highlighted
Specifies the highlighting, if any, with which error messages are to be displayed. The forms of highlighting you can specify are blink, reverse or underline.
-
getErrintensify
ITypetermDefinition.ErrintensifyValue getErrintensify()
Getter for field ERRINTENSIFYError message display intensified
Specifies whether the error message is to be displayed in an intensified field.
-
getErrlastline
ITypetermDefinition.ErrlastlineValue getErrlastline()
Getter for field ERRLASTLINEDisplay error messages on last line
Specifies where error messages are to be displayed:
- NO - An error message is displayed at the current cursor position and without any additional attributes.
- YES - An error message is displayed starting at the beginning of the line nearest the bottom of the screen so that the whole message fits on the screen.
-
getExtendedds
ITypetermDefinition.ExtendeddsValue getExtendedds()
Getter for field EXTENDEDDSExtended 3270 data stream
Specifies whether the 3270 device or the SCS printer supports extensions to the 3270 data stream.
-
getFmhparm
ITypetermDefinition.FmhparmValue getFmhparm()
Getter for field FMHPARMAccept user-supplied data in function management header (FMH)
Specifies whether BMS is to accept user-supplied parameters for inclusion in the function management header built by BMS. Specify YES only if the DEVICE type is 3650.
-
getFormfeed
ITypetermDefinition.FormfeedValue getFormfeed()
Getter for field FORMFEEDFormfeed feature
Specifies whether or not the device has the forms feed feature, which means that BMS uses the form-feed character when formatting output documents.
-
getHilight
ITypetermDefinition.HilightValue getHilight()
Getter for field HILIGHTExtended highlight supported
specifies 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 blink (3270 only).
-
getHorizform
ITypetermDefinition.HorizformValue getHorizform()
Getter for field HORIZFORMBMS is to use horizontal tabbing
Specifies whether or not the device has the horizontal form feature, which means that BMS should use the horizontal tabbing when formatting output documents.
-
getIoarealen
java.lang.Long getIoarealen()
Getter for field IOAREALENI/O buffer length
The length in bytes of a terminal input/output area to be passed to a transaction.
You can specify IOAREALENALT as greater than or equal to IOAREALEN. In this case, when the size of an input message exceeds IOAREALEN, CICS uses a terminal input/output area the size of IOAREALENALT. If the input message size also exceeds IOAREALENALT, the node abnormal condition program sends an exception response to the terminal. If IOAREALENALT is not specified, or is less than IOAREALEN, it defaults to the value of IOAREALEN.
The maximum value that may be specified is 32767 bytes.
-
getIoarealenalt
java.lang.Long getIoarealenalt()
Getter for field IOAREALENALTAlternate I/O buffer length
The alternate length in bytes of a terminal input/output area to be passed to a transaction.
You can specify IOAREALENALT as greater than or equal to IOAREALEN. In this case, when the size of an input message exceeds IOAREALEN, CICS uses a terminal input/output area the size of IOAREALENALT. If the input message size also exceeds IOAREALENALT, the node abnormal condition program sends an exception response to the terminal. If IOAREALENALT is not specified, or is less than IOAREALEN, it defaults to the value of IOAREALEN.
The maximum value that may be specified is 32767 bytes.
-
getKatakana
ITypetermDefinition.KatakanaValue getKatakana()
Getter for field KATAKANAKatakana feature
Specifies whether Katakana support is required. Katakana terminals cannot display mixed case output; uppercase characters appear as uppercase English characters, but lowercase characters appear as Katakana characters.
-
getLdclist
java.lang.String getLdclist()
Getter for field LDCLISTName of logical device code list
The name of a logical device code (LDC) list. The name may be up to eight characters in length. The name follows assembler language rules. It must start with an alphabetic character.
-
getLightpen
ITypetermDefinition.LightpenValue getLightpen()
Getter for field LIGHTPENSelector pen feature
Specifies whether a 3270 display has the selector pen feature
-
getLogmode
java.lang.String getLogmode()
Getter for field LOGMODELogmode name
Specifies how CICS is to build the BIND to be sent to the logical unit.
- blank - A defined terminal definition uses the BIND image generated by the CICS definitions for this device by means of this TYPETERM definition and its associated terminal definitions.
- name - This is the LOGMODE name from a VTAM logon mode table that has been set up for use by this logical unit. The name may be up to eight characters in length.
- 0 (zero) - This causes CICS to use some of the information from the BIND image contained in the CINIT coming from the logical unit.
-
getLogonmsg
ITypetermDefinition.LogonmsgValue getLogonmsg()
Getter for field LOGONMSGGood Morning transaction autoinitiation
Specifies whether the 'good morning' transaction, specified in the GMTRAN system initialization parameter, will be:
- Automatically initiated when the logical unit is first logged on to CICS through VTAM
- Initiated after the terminal user's TIMEOUT period has expired under certain conditions.
-
getMsrcontrol
ITypetermDefinition.MsrcontrolValue getMsrcontrol()
Getter for field MSRCONTROLMagnetic slot reader supported
Specifies whether the terminal, an 8775 or 3643, has a magnetic slot reader.
-
getNepclass
java.lang.Long getNepclass()
Getter for field NEPCLASSNode error program transaction class
The node error program transaction class:
- 0 - This results in a link to the default node error program module.
- value - The transaction class for the (nondefault) node error program module in the range 1 through 255.
-
getObformat
ITypetermDefinition.ObformatValue getObformat()
Getter for field OBFORMATOutboard formatting to be used
Specifies whether outboard formatting is used. This can be specified for two device types only:
- 3650 SESSIONTYPE(3270)
- LUTYPE2, for an 8100 Information System using the DPPX operating system with DPPX/DPS Version 2 for presentation services
-
getOboperid
ITypetermDefinition.OboperidValue getOboperid()
Getter for field OBOPERIDOutboard operator ID BMS routing
Specifies whether CICS uses the outboard operator identifiers to support the BMS routing facilities required for this terminal. This option applies only to the 3790 and 3770 batch data interchange logical units.
-
getOutline
ITypetermDefinition.OutlineValue getOutline()
Getter for field OUTLINEDevice supports field outline
Specifies whether the device supports field outlining.
-
getPagesizecol
java.lang.Long getPagesizecol()
Getter for field PAGESIZECOLPage size (number of columns)
The number of columns for the default page size for this type of printer when attached to a transaction, for which the default screen size has been specified in an associated profile definition (PROFDEF). Both the rows and columns values must each be in the range 0 through 255. In addition, if the product of rows and columns value exceeds 32767 then CICS will reject any attempt to install this TYPTMDEF. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
-
getPagesizerow
java.lang.Long getPagesizerow()
Getter for field PAGESIZEROWPage size (number of rows)
The number of rows for the default page size for this type of printer when attached to a transaction, for which the default screen size has been specified in an associated profile definition (PROFDEF). Both the rows and columns values must each be in the range 0 through 255. In addition, if the product of rows and columns value exceeds 32767 then CICS will reject any attempt to install this TYPTMDEF. If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
-
getPartitions
ITypetermDefinition.PartitionsValue getPartitions()
Getter for field PARTITIONSDevice uses partitions
Specifies whether a device is to use partitions. This option is not valid for SCS printers.
-
getPrintadapter
ITypetermDefinition.PrintadapterValue getPrintadapter()
Getter for field PRINTADAPTERPrinter adapter feature
- For the 3275: specifies whether the printer adapter feature and corresponding 3284
Printer Model 3 are present on the 3275 Display Station:
- NO - The printer adapter feature and corresponding 3284 Printer Model 3 are not available.
- YES - The printer adapter feature and corresponding 3284 Printer Model 3 are available.
- For LUTYPE2 logical units: specifies whether, for print requests initiated by the PRINT
key or by an ISSUE PRINT command, printer allocation is handled by the 3790, or by the 3274
or 3276, according to the printer authorization matrix for both VTAM and non-VTAM
attachments.
- NO - Print requests are not handled according to the printer authorization matrix for both VTAM and non-VTAM attachments.
- YES - Print requests are handled according to the printer authorization matrix for both VTAM and non-VTAM attachments.
- For the 3275: specifies whether the printer adapter feature and corresponding 3284
Printer Model 3 are present on the 3275 Display Station:
-
getProgsymbols
ITypetermDefinition.ProgsymbolsValue getProgsymbols()
Getter for field PROGSYMBOLSProgrammed symbols can be used
Specifies whether the programmed symbol (PS) facility can be used on this 3270 device or SCS printer.
-
getQuery
ITypetermDefinition.QueryValue getQuery()
Getter for field QUERYQuery structured field to be used
Specifies whether CICS should use the QUERY structured field to determine the characteristics of the device:
- NO - CICS does not use the QUERY function.
- COLD - CICS uses the QUERY function to determine the characteristics of the device only when the device is first connected after an initial or a cold start of CICS. The device characteristics are stored in the CICS global catalog for use on subsequent warm and emergency starts.
- ALL - CICS uses the QUERY function to determine the characteristics of the device each time the device is connected
-
getReceivesize
java.lang.Long getReceivesize()
Getter for field RECEIVESIZEMaximum size of request unit
The maximum size of a request unit that can satisfy a VTAM RECEIVE request. The RECEIVESIZE value is transmitted to the connected logical unit, and must be in the range 0 through 30720. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there are any.
-
getRecovnotify
ITypetermDefinition.RecovnotifyValue getRecovnotify()
Getter for field RECOVNOTIFYXRF recovery notification option
This option applies to the recovery of sessions for terminals in a CICS region running with either VTAM persistent sessions or with XRF. It is for use in situations where a terminal user may have to take action, such as sign on again, after a CICS restart. Use RECOVNOTIFY to specify how such a user should be notified.
VTAM persistent sessions: In a CICS region running with persistent session support, this specifies how a terminal end user is notified that their terminal session has been recovered.
XRF: In a CICS region running with XRF support, this specifies how the terminal user is notified that an XRF takeover has occurred. This option is not applicable to APPC sessions.
Valid options are:- NONE - There is no notification that a takeover has occurred.
- MESSAGE - A message is displayed on the screen to say that the system has recovered. The message is specified in two BMS maps; DFHXRC1 and DFHXRC2 for XRF; and DFHXRC3 and DFHXRC4 for VTAM persistent sessions. These maps are in map set DFHXMSG. If reduced takeover time is important, use MESSAGE rather than TRANSACTION. The terminal must be defined with the ATI(YES) option, and must be capable of displaying a BMS map.
- TRANSACTION - A transaction is initiated at the terminal. The name of the transaction is specified by the RMTRAN system initialization parameter. (The default transaction for RMTRAN is the one specified in the GMTRAN system initialization parameter: the good-morning transaction.) For the TRANSACTION option, the terminal must be defined with the ATI(YES) option. If reduced takeover time is important, use MESSAGE rather than TRANSACTION.
-
getRecovoption
ITypetermDefinition.RecovoptionValue getRecovoption()
Getter for field RECOVOPTIONSession recovery option
This applies to the recovery of sessions in a CICS region running with VTAM persistent sessions, or with XRF.
- SYSDEFAULT - In a CICS region running with persistent sessions support, this specifies that CICS is to select the optimum procedure to recover a session on system restart within the persistent session delay interval, depending on the session activity and on the characteristics of the terminal. In a CICS region running with XRF support, this specifies that CICS is to select the optimum procedure to recover a busy session at takeover, depending on the session activity and on the characteristics of the terminal.
- CLEARCONV - Prevents CICS from sending an end-bracket indicator to close an in-bracket session. Instead CICS sends a CLEAR request, to reset the conversation states. If the session does not support the CLEAR request, CICS sends an UNBIND request. The CLEAR or UNBIND is sent only if the session was busy at the time of system restart (in the case of persistent sessions) or takeover (in the case of XRF).
- RELEASESESS - Requires CICS to send an UNBIND request to release the active session. The UNBIND is sent only if the session was busy at the time of system restart (in the case of persistent sessions), or takeover (in the case of XRF).
- UNCONDREL - Requires CICS to send an UNBIND request to release the active session. The UNBIND is sent whether or not the session was busy at the time of system restart (in the case of persistent sessions support) or the takeover (in the case of XRF).
- NONE - VTAM persistent sessions: In a CICS region running with persistent sessions support, this specifies that the terminal session is not to be recovered at system restart within the persistent session delay interval: in effect, the terminal has no persistent sessions support.
-
getRelreq
ITypetermDefinition.RelreqValue getRelreq()
Getter for field RELREQHonor release requests
Specifies whether CICS is to release the logical unit upon request by another VTAM application program.
- NO - CICS is not to release the logical unit.
- YES - CICS is to release the logical unit, if the logical unit is not currently part of a transaction.
-
getRoutedmsgs
ITypetermDefinition.RoutedmsgsValue getRoutedmsgs()
Getter for field ROUTEDMSGSMessages routed to terminal support
Specifies which messages are to be routed to this terminal by an EXEC CICS ROUTE command.
- ALL - BMS routes to this terminal messages that are destined for all terminals as well as those specifically destined for this terminal.
- NONE - BMS does not route any messages to this terminal, whether they are destined for all terminals or for this terminal specifically.
- SPECIFIC - BMS routes messages to this terminal when they are destined specifically for this terminal, but not when they are destined for all terminals.
-
getSendsize
java.lang.Long getSendsize()
Getter for field SENDSIZEMaximum send size
The maximum size of a request unit in bytes that can satisfy a VTAM SEND request, in the range 0 through 30720. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.
-
getSessiontype
java.lang.String getSessiontype()
Getter for field SESSIONTYPEType of session
The type of session that can be used for a VTAM SNA logical unit.
-
getShippable
ITypetermDefinition.ShippableValue getShippable()
Getter for field SHIPPABLEDefinition shipped to a remote system
Specifies whether the definition is allowed to be sent to a remote system if this device tries to initiate a remote transaction.
-
getSignoff
ITypetermDefinition.SignoffValue getSignoff()
Getter for field SIGNOFFAutomatic timeout
Specifies whether the terminal should be timed out automatically:
- YES - When the specified time has elapsed after the last input from the operator, the terminal is automatically signed off from CICS.
- NO - The terminal is not timed out.
- LOGOFF - When the specified time has elapsed after the last input from the operator, the terminal is automatically signed off from CICS and then logged off from VTAM
-
getSosi
ITypetermDefinition.SosiValue getSosi()
Getter for field SOSIMixed EBCDIC/DBCS supported
Specifies whether the device supports mixed EBCDIC and double-byte character set (DBCS) fields.
-
getTextkybd
ITypetermDefinition.TextkybdValue getTextkybd()
Getter for field TEXTKYBDText-keyboard feature
Specifies whether the 3270 device has the text-keyboard feature.
-
getTextprint
ITypetermDefinition.TextprintValue getTextprint()
Getter for field TEXTPRINTText-print feature
Specifies whether the 3288 printer has the text-print feature.
-
getTti
ITypetermDefinition.TtiValue getTti()
Getter for field TTITransactions started via user
Specifies whether transactions can be initiated at the terminal by a user.
-
getUctran
ITypetermDefinition.UctranValue getUctran()
Getter for field UCTRANInput translated to uppercase
Specifies whether the input data stream from a terminal is to be translated to uppercase:
- NO - No uppercase translation is performed.
- YES - All the data input from the terminal, both the transaction identifier if present and the program data, is translated to uppercase before any processing.
- TRANID - When the input data stream includes a transaction identifier, CICS translates it to uppercase before attempting to locate its definition. However, all the input data, both the transaction identifier and the program data, is passed to the program without any translation.
-
getValidation
ITypetermDefinition.ValidationValue getValidation()
Getter for field VALIDATIONDevice supports extended validation
Specifies whether or not an 8775 or 3290 device has the extended validation feature.
-
getVerticalform
ITypetermDefinition.VerticalformValue getVerticalform()
Getter for field VERTICALFORMBMS to use vertical tabbing
Specifies whether the device has the vertical form feature.
-
getUserarealen
java.lang.Long getUserarealen()
Getter for field USERAREALENUser area length
The length in bytes (0 to 255) of the user area for this terminal. If you leave this field blank, CICSPlex SM uses the default values for your CICS environment, if there are any.
-
getAltsuffix
java.lang.String getAltsuffix()
Getter for field ALTSUFFIXMap set name suffix
A 1-character numeric suffix that BMS is to append to map set names.
- blank - Leave this attribute blank if you do not want a suffixed map set.
- number - BMS appends this suffix to map set names if the screen size being used is the same value as the alternate screen size; that is, if the transaction has an alternate screen size specified in the PROFILE definition, or if the default and alternate screen size are the same.
-
getTermmodel
java.lang.Long getTermmodel()
Getter for field TERMMODELTerminal model number
The model number of the terminal. If the device is a component of the 3270 Information Display System, specify the model number of the terminal:
- 1 - Specify 1 for the 3270 Model 1 displays and printers (for example, 3277 Model 1) with a default screen or buffer size of 12x40 (480 bytes/characters). TERMMODEL(1) is the default for 3270 Model 1 printers and displays. Specify 1 for the 3275 Display Station Model 11. The CICS support obtained is identical to that obtained by coding TERMMODEL(1) for 3275 Display Station Model 1.
- 2 - Specify 2 for the 3270 displays and printers (for example, 3278 Model 4) with a default screen or buffer size of 24x80 (1920 bytes/characters). TERMMODEL(2) is the default for the 3286 printer in 3270 compatibility mode. Specify 2 for the 3275 Display Station Model 12. The CICS support obtained is identical to that obtained by coding TERMMODEL(2) for 3275 Display Station Model 2.
-
getUserdata1
java.lang.String getUserdata1()
Getter for field USERDATA1User data area 1
Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.
-
getUserdata2
java.lang.String getUserdata2()
Getter for field USERDATA2User data area 2
Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.
-
getUserdata3
java.lang.String getUserdata3()
Getter for field USERDATA3User data area 3
Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.
-
getRstsignoff
ITypetermDefinition.RstsignoffValue getRstsignoff()
Getter for field RSTSIGNOFFSign-on characteristics
The sign-on characteristics of a group of terminals in the event of a persistent sessions restart or an XRF takeover. It supersedes the XRFSIGNOFF attribute, which is obsolete. If you have a collection of terminals in a security-sensitive area, for example, you might choose to force sign off of those terminals after a persistent sessions restart or an XRF takeover, to prevent the use of the terminal in the absence of the authorized user. (This could happen if the authorized user left the terminal during the restart or takeover, and the terminal became active again while it was unattended.) This option works in conjunction with the RSTSIGNOFF system initialization parameter and the XRFSOFF entry in the CICS segment of the RACF user profile.
-
getCICSObjectReference
ICICSDefinitionReference<ITypetermDefinition> getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSDefinition
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceIDefinition
-
-