com.ibm.cics.model
Interface ISessionDefinition

All Superinterfaces:
ICICSDefinition, ICICSObject, IDefinition, com.ibm.cics.model.meta.ITypedObject

public interface ISessionDefinition
extends ICICSDefinition

generated from CICS resourcetable SESSDEF


Nested Class Summary
static class ISessionDefinition.AutoconnectValue
          Enumeration type for field AUTOCONNECT
static class ISessionDefinition.ProtocolValue
          Enumeration type for field PROTOCOL
static class ISessionDefinition.RecovoptionValue
          Enumeration type for field RECOVOPTION
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,ISessionDefinition> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 ISessionDefinition.AutoconnectValue getAutoconnect()
          Getter for field AUTOCONNECT
 ICICSEnums.YesNoValue getBuildchain()
          Getter for field BUILDCHAIN
 ICICSDefinitionReference<ISessionDefinition> getCICSObjectReference()
           
 java.lang.String getConnection()
          Getter for field CONNECTION
 ICICSEnums.YesNoValue getDiscreq()
          Getter for field DISCREQ
 java.lang.Long getIoarealen()
          Getter for field IOAREALEN
 java.lang.Long getIoarealen2()
          Getter for field IOAREALEN2
 java.lang.Long getMaxctwin()
          Getter for field MAXCTWIN
 java.lang.Long getMaxingrp()
          Getter for field MAXINGRP
 java.lang.String getModename()
          Getter for field MODENAME
 java.lang.Long getNepclass()
          Getter for field NEPCLASS
 java.lang.String getNetnameq()
          Getter for field NETNAMEQ
 ICICSType<ISessionDefinition> getObjectType()
           
 ISessionDefinition.ProtocolValue getProtocol()
          Getter for field PROTOCOL
 java.lang.Long getReceivecount()
          Getter for field RECEIVECOUNT
 java.lang.String getReceivepfx()
          Getter for field RECEIVEPFX
 java.lang.Long getReceivesize()
          Getter for field RECEIVESIZE
 ISessionDefinition.RecovoptionValue getRecovoption()
          Getter for field RECOVOPTION
 ICICSEnums.YesNoValue getRelreq()
          Getter for field RELREQ
 java.lang.Long getSendcount()
          Getter for field SENDCOUNT
 java.lang.String getSendpfx()
          Getter for field SENDPFX
 java.lang.Long getSendsize()
          Getter for field SENDSIZE
 java.lang.String getSessname()
          Getter for field SESSNAME
 java.lang.Long getSesspriority()
          Getter for field SESSPRIORITY
 java.lang.Long getUserarealen()
          Getter for field USERAREALEN
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 java.lang.String getUserid()
          Getter for field USERID
 
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime, getCSDGroup, getDescription, getVersion
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

ICICSType<ISessionDefinition> getObjectType()
Specified by:
getObjectType in interface ICICSDefinition
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface IDefinition
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

getAutoconnect

ISessionDefinition.AutoconnectValue getAutoconnect()
Getter for field AUTOCONNECT

Autoconnect option

Specifies how connections are to be established.

For a APPC VTAM-connected system that has Autoconnect set to YES or ALL on the connection definition:

For a APPC VTAM-connected system that has Autoconnect set to NO on the CONNECTION definition:

For LU6.1 sessions:


getBuildchain

ICICSEnums.YesNoValue getBuildchain()
Getter for field BUILDCHAIN

Chain assembly required

Specifies whether CICS is to perform chain assembly before passing the input data to the application program:


getConnection

java.lang.String getConnection()
Getter for field CONNECTION

Connection definition name

The name of the connection definition to be used with this session definition. The name can be up to four characters in length.


getDiscreq

ICICSEnums.YesNoValue getDiscreq()
Getter for field DISCREQ

Honor disconnect reqeusts

Specifies whether disconnect requests are to be honored. DISCREQ applies to LUTYPE6.1 ISC sessions, but not to MRO sessions where CICS is not dealing with VTAM devices.


getIoarealen

java.lang.Long getIoarealen()
Getter for field IOAREALEN

Minimum terminal input output area (TIOA) size

The minimum size, in bytes, of the terminal input/output area to be used for processing messages transmitted on the MRO link.


getIoarealen2

java.lang.Long getIoarealen2()
Getter for field IOAREALEN2

Alternate terminal input output area (TIOA) size

The length, in bytes, of the terminal input/output area to be used for processing messages transmitted on the MRO link. If the alternative TIOA value is not specified, or is less than the minimum TIOA value (IOAREALEN) , it defaults to the value of the minimum TIOA.


getMaxingrp

java.lang.Long getMaxingrp()
Getter for field MAXINGRP

Maximum number of sessions in the group

The maximum number of sessions in the group. This value can be in the range 1 through 999. The default is 1. This value must be more than the maximum number of contention winner sessions (MAXTWIN).


getMaxctwin

java.lang.Long getMaxctwin()
Getter for field MAXCTWIN

Maximum number of contention winner sessions

The maximum number of sessions that are to be supported as contention winners. This value can be in the range 0 to 999. The default is 0. Note that this operand has no meaning for a single session connection. This value must be less than the maximum number of sessions in the group (MAXINGRP).


getModename

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

Mode 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, and must be the name of a VTAM LOGMODE entry defined to VTAM (APPC only).


getNepclass

java.lang.Long getNepclass()
Getter for field NEPCLASS

Network error program transaction class

The transaction class for the node error program:

If you leave these fields blank, CICSPlex SM uses the default values for your CICS environment, if there are any.


getNetnameq

java.lang.String getNetnameq()
Getter for field NETNAMEQ

Name IMS system uses to identify session

The name by which the remote IMS system knows this particular session. This is used for CICS-IMS sessions.


getProtocol

ISessionDefinition.ProtocolValue getProtocol()
Getter for field PROTOCOL

Intercommunication link protocol

The type of protocol that is to be used for an intercommunication link (ISC or MRO):


getReceivecount

java.lang.Long getReceivecount()
Getter for field RECEIVECOUNT

Receive count

For MRO, and VTAM LU6.1 sessions, and for sessions with EXCI clients, specifies the number of sessions that normally receive before sending.


getReceivesize

java.lang.Long getReceivesize()
Getter for field RECEIVESIZE

Receive buffer size

The maximum VTAM request unit (RU) size that the session is capable of receiving. The value must be between 1 and 30720 for LU61 sessions, or 256 and 30720 for APPC sessions. The default is 4096.


getRecovoption

ISessionDefinition.RecovoptionValue getRecovoption()
Getter for field RECOVOPTION

Recovery option

Specifies the type of recovery for sessions in a CICS region running with VTAM persistent sessions.


getRelreq

ICICSEnums.YesNoValue getRelreq()
Getter for field RELREQ

Honor release requests

Specifies whether CICS is to release the logical unit upon request by another VTAM application program.


getSendcount

java.lang.Long getSendcount()
Getter for field SENDCOUNT

Send count

For MRO, and VTAM LU6.1 sessions, and for sessions with EXCI clients, specifies the number of send sessions; that is, sessions that normally send before receiving.


getSendsize

java.lang.Long getSendsize()
Getter for field SENDSIZE

Send buffer size

The maximum VTAM request unit (RU) size that these sessions are capable of sending, in the range 1 through 30720 for LU 6.1 sessions, or 256 through 30720 for APPC sessions.


getSessname

java.lang.String getSessname()
Getter for field SESSNAME

Session name

The symbolic identification to be used as the local half of a session qualifier pair in a CICS intercommunication parallel session. The name can be up to four characters in length.


getSesspriority

java.lang.Long getSesspriority()
Getter for field SESSPRIORITY

Session priority

The terminal priority - this decimal value (0 through 255) is used in establishing the overall transaction processing priority. (Transaction processing priority is equal to the sum of the terminal priority, transaction priority, and operator priority; this must not exceed 255.) If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.


getUserarealen

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

User area size

The length, in bytes, of the user area for this session, in the range 0 through 255. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.


getUserid

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

User signon ID

A user identifier used for sign-on (SEC=YES or MIGRATE) and referred to in security error messages, security violation messages, and the audit trail. The name can be up to eight characters in length.


getReceivepfx

java.lang.String getReceivepfx()
Getter for field RECEIVEPFX

Receive prefix

A 1-or 2-character prefix that CICS is to use as the first one or two characters of the receive session names (the names of the terminal control table terminal entries (TCTTEs) for the sessions).


getSendpfx

java.lang.String getSendpfx()
Getter for field SENDPFX

Send prefix

A 1-or 2-character prefix that CICS is to use as the first one or two characters of the send session names (the names of the terminal control table terminal entries (TCTTEs) for the sessions). The prefix you select must not result in any duplicate session or terminal names.


getUserdata1

java.lang.String getUserdata1()
Getter for field USERDATA1

User 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 USERDATA2

User 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 USERDATA3

User 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.


getCICSObjectReference

ICICSDefinitionReference<ISessionDefinition> getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSDefinition
Specified by:
getCICSObjectReference in interface ICICSObject
Specified by:
getCICSObjectReference in interface IDefinition

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,ISessionDefinition> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. The list factory can be activated by the caller when necessary. This method does not perform any I/O.



Copyright © 2008-2013 IBM Corp. All Rights Reserved.