Interface IProfileDefinition
-
- All Superinterfaces:
ICICSDefinition,ICICSObject,IDefinition,com.ibm.cics.model.meta.ITypedObject
public interface IProfileDefinition extends ICICSDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIProfileDefinition.ChaincontrolValueEnumeration type for field CHAINCONTROLstatic classIProfileDefinition.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classIProfileDefinition.DvsuprtValueEnumeration type for field DVSUPRTstatic classIProfileDefinition.InbfmhValueEnumeration type for field INBFMHstatic interfaceIProfileDefinition.JournalValueLong constants interface for field JOURNALstatic classIProfileDefinition.LogrecValueEnumeration type for field LOGRECstatic classIProfileDefinition.MsgintegValueEnumeration type for field MSGINTEGstatic classIProfileDefinition.MsgjrnlValueEnumeration type for field MSGJRNLstatic classIProfileDefinition.OnewteValueEnumeration type for field ONEWTEstatic classIProfileDefinition.PrintercompValueEnumeration type for field PRINTERCOMPstatic classIProfileDefinition.RaqValueEnumeration type for field RAQstatic interfaceIProfileDefinition.RtimoutValueLong constants interface for field RTIMOUTstatic classIProfileDefinition.ScrnsizeValueEnumeration type for field SCRNSIZEstatic classIProfileDefinition.UctranValueEnumeration type for field UCTRAN
-
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 IProfileDefinition.ChaincontrolValuegetChaincontrol()Getter for field CHAINCONTROLIProfileDefinition.ChangeAgentValuegetChangeAgent()Getter for field CHANGEAGENTICICSDefinitionReference<IProfileDefinition>getCICSObjectReference()IProfileDefinition.DvsuprtValuegetDvsuprt()Getter for field DVSUPRTjava.lang.StringgetFacilitylike()Getter for field FACILITYLIKEIProfileDefinition.InbfmhValuegetInbfmh()Getter for field INBFMHjava.lang.LonggetJournal()Getter for field JOURNALIProfileDefinition.LogrecValuegetLogrec()Getter for field LOGRECjava.lang.StringgetModename()Getter for field MODENAMEIProfileDefinition.MsgintegValuegetMsginteg()Getter for field MSGINTEGIProfileDefinition.MsgjrnlValuegetMsgjrnl()Getter for field MSGJRNLjava.lang.LonggetNepclass()Getter for field NEPCLASSICICSType<IProfileDefinition>getObjectType()IProfileDefinition.OnewteValuegetOnewte()Getter for field ONEWTEIProfileDefinition.PrintercompValuegetPrintercomp()Getter for field PRINTERCOMPIProfileDefinition.RaqValuegetRaq()Getter for field RAQjava.lang.LonggetRtimout()Getter for field RTIMOUTIProfileDefinition.ScrnsizeValuegetScrnsize()Getter for field SCRNSIZEIProfileDefinition.UctranValuegetUctran()Getter for field UCTRANjava.lang.StringgetUserdata1()Getter for field USERDATA1java.lang.StringgetUserdata2()Getter for field USERDATA2java.lang.StringgetUserdata3()Getter for field USERDATA3-
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<IProfileDefinition> getObjectType()
- Specified by:
getObjectTypein interfaceICICSDefinition- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfaceIDefinition- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
IProfileDefinition.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.
-
getChaincontrol
IProfileDefinition.ChaincontrolValue getChaincontrol()
Getter for field CHAINCONTROLOutbound chaining control
Specifies whether the application program can control the outbound chaining of request units.
-
getDvsuprt
IProfileDefinition.DvsuprtValue getDvsuprt()
Getter for field DVSUPRTSupported devices
The devices (terminals or logical units) that are to be supported:
- ALL - The profile can be used with any terminal or logical unit.
- NONVTAM - The profile can be used only with non-VTAM terminals.
- VTAM - The profile can be used only with logical units.
-
getInbfmh
IProfileDefinition.InbfmhValue getInbfmh()
Getter for field INBFMHPass function management header (FMH) to application
Specifies, for profiles used with logical units, whether a function management header (FMH) received from a logical unit is to be passed to the application program:
- ALL - All FMHs (except APPC FMHs and LU6.1 ATTACH and SYNCPOINT FMHs that are processed by CICS) are passed to the application program. This value is required for function shipping transactions such as CSMI, transactions which use distributed transaction processing, and for distributed program link requests.
- DIP - The batch data interchange program (DFHDIP) is to process inbound FMHs. BMS issues a batch data interchange receive request if a BMS receive request has been issued, and a batch data interchange receive request is issued instead of a terminal control receive request.
- EODS - An FMH is passed to the application program only if it indicates end of data set (EODS).
- NO - The FMHs are discarded.
-
getLogrec
IProfileDefinition.LogrecValue getLogrec()
Getter for field LOGRECReceive requires logical record
Specifies whether the design of the application requires that each EXEC CICS RECEIVE request is to be satisfied by a logical record.
-
getModename
java.lang.String getModename()
Getter for field MODENAMEMode name
The name that identifies a group of sessions for use on an APPC connection. The name can be up to eight characters in length.
-
getMsginteg
IProfileDefinition.MsgintegValue getMsginteg()
Getter for field MSGINTEGMessage response requested
Specifies whether a definite response is to be requested with an output request to a logical unit.
-
getMsgjrnl
IProfileDefinition.MsgjrnlValue getMsgjrnl()
Getter for field MSGJRNLMessages to be journaled
Specifies which messages are to be automatically journaled:
- NO - No message journaling is required.
- INPUT - Journaling is required for input messages.
- OUTPUT - Journaling is to be performed for output messages.
- INOUT - Journaling is to be performed for input and output messages.
-
getOnewte
IProfileDefinition.OnewteValue getOnewte()
Getter for field ONEWTEOne write operation
Specifies whether the transaction is permitted only one write operation or EXEC CICS SEND during its execution. YES has the effect of forcing the LAST option on the first write of the transaction. Any additional write requests are treated as errors, and the task is made ready for abnormal termination.
-
getPrintercomp
IProfileDefinition.PrintercompValue getPrintercomp()
Getter for field PRINTERCOMPPrinter compatability option
The level of compatibility required for the generation of data streams to support the printer compatibility option for the BMS SEND TEXT command.
- NO - Each line of output starts with a blank character, so that the format is equivalent to that on a 3270 display where an attribute byte precedes each line.
- YES - No blank character is inserted, so that forms-feed characters included as the first character of your data are honored and the full width of the printer is available for your data. If you use the BMS forms feed option, select YES.
-
getRaq
IProfileDefinition.RaqValue getRaq()
Getter for field RAQRead ahead queueing option
Specifies whether the 'read ahead queuing' option is required:
- NO - The transaction obeys SNA protocols and only SEND and RECEIVE when in the correct mode. If it does not follow the protocol, it may be abended with code ATCV.
- YES - The transaction may not obey SNA protocols, and CICS queues incoming data on temporary storage until the data is specifically requested by the transaction. RAQ(YES) is provided only for compatibility with transactions that support both bisynchronous devices and logical units, and its use is not recommended.
-
getUctran
IProfileDefinition.UctranValue getUctran()
Getter for field UCTRANUpper case translation
Specifies whether terminal input is to be translated to uppercase before passing to programs for the transaction using this profile. (VTAM only.)
-
getScrnsize
IProfileDefinition.ScrnsizeValue getScrnsize()
Getter for field SCRNSIZEScreen size
Specifies whether the DEFAULT or ALTERNATE buffer size for a 3270 display or printer is to be used. The SCRNSIZE value is ignored if the TYPETERM definition has ALTSCREEN(0,0) and DEFSCREEN(0,0). That is, the screen size is assumed from the related TERMMODEL attribute in the TYPETERM definition; the page size is taken from PAGESIZE, and the ALTPAGE value is ignored. The 3270 erase write (EW) command is inserted for output requests with the ERASE option.
-
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 for VTAM devices, or is the default value for non-VTAM devices.
- value - The transaction class for the (nondefault) node error program module. The value can be in the range 1 through 255.
-
getRtimout
java.lang.Long getRtimout()
Getter for field RTIMOUTRead time-out value
The time-out value:
- for the read time-out feature. The task that is timed out receives an AKCT, AZCT or AZIG abend. If a value is specified and you wish to let it default to NO, you must completely delete the value previously specified.
- to terminate an IIOP request processor task that has been waiting for a method request for longer than the RTIMOUT value.
- NO - The read time-out feature is not required.
- value - This is an interval (MMSS for minutes and seconds) after which the task is terminated if no input has been received from the terminal. The maximum value that can be specified is 70 minutes.
-
getJournal
java.lang.Long getJournal()
Getter for field JOURNALJournal identifier
Specifies whether automatic journaling of messages takes place, by giving the identifier of the journal. Options are:
- NO - No automatic journaling of messages is to take place.
- number - The journal identification to be used for automatic journaling. This can be any number in the range 01 through 99. This number is appended to the letters DFHJ to give a journal identification of the form DFHJnn and this maps to an MVS system logger general log stream.
-
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.
-
getFacilitylike
java.lang.String getFacilitylike()
Getter for field FACILITYLIKEFacility model
The 1- to 4-character name of a terminal definition or an installed terminal definition (TERMDEF) to be used as a template by a bridge exit. When this transaction is run in a 3270 bridge environment, the principal facility will be built to have the same attributes as the terminal defined by this field. There is no default value for this attribute.
-
getCICSObjectReference
ICICSDefinitionReference<IProfileDefinition> getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSDefinition- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceIDefinition
-
-