Interface ILocalTransaction

    • Method Detail

      • getName

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

        Transaction ID

        The 4-character transaction name.

        Specified by:
        getName in interface ICICSObject
      • getCommandSecurity

        ILocalTransaction.CommandSecurityValue getCommandSecurity()
        Getter for field CMDSEC

        Command level security option

        Indicates whether command security checking is to be applied on system programming commands. Options are CMDSECYES or CMDSECNO.

      • getDeadlockTimeout

        java.lang.Long getDeadlockTimeout()
        Getter for field DTIMEOUT

        Deadlock timeout (seconds)

        The deadlock time-out value, in seconds, for suspended tasks associated with this transaction.

      • getDumping

        ILocalTransaction.DumpingValue getDumping()
        Getter for field DUMPING

        Transaction dump option

        Indicates whether transaction dumps are taken when the transaction terminates abnormally.

        Input Values: TRANDUMP, NOTRANDUMP

      • getPriority

        java.lang.Long getPriority()
        Getter for field PRIORITY

        Transaction priority

        The priority of this transaction relative to other transactions in the CICS system.

        Input Values: 1 - 255

      • getProgram

        java.lang.String getProgram()
        Getter for field PROGRAM

        First program name

        The name of the first program to be executed when this transaction is started.

      • getPurgeability

        ILocalTransaction.PurgeabilityValue getPurgeability()
        Getter for field PURGEABILITY

        Purgeability option

        Indicates whether the transaction is purgeable in system stall conditions.

        Input Values: PURGEABLE, NOTPURGEABLE

      • getReadTimeout

        java.lang.Long getReadTimeout()
        Getter for field RTIMEOUT

        Read timeout (seconds)

        The read time-out value, which is the number of seconds after which a task associated with this transaction is terminated if no input is received. If this value is 0 and the Profile field is blank, then the read time-out value could not be determined because the transaction profile was not available.

      • getScreenSize

        ILocalTransaction.ScreenSizeValue getScreenSize()
        Getter for field SCRNSIZE

        Screen size

        Indicates whether the default or alternate screen size is to be used when this transaction is run. A value of N/A means the screen size could not be determined because the transaction profile was not available.

      • getStatus

        ICICSEnums.EnablementValue getStatus()
        Getter for field STATUS

        Enabled status

        The enabled status of the transaction, which indicates whether it is available for use.

        Input Values: ENABLED, DISABLED

      • getTracing

        ILocalTransaction.TracingValue getTracing()
        Getter for field TRACING

        Tracing type

        Indicates whether tracing for this transaction is to be special, standard, or suppressed.

        Input Values: SPECTRACE, STANTRACE, SPRSTRACE

      • getTWASize

        java.lang.Long getTWASize()
        Getter for field TWASIZE

        Size in bytes of transaction work area (TWA)

        The size of the associated transaction work area (TWA) in bytes.

      • getUseCount

        java.lang.Long getUseCount()
        Getter for field USECOUNT

        Number of times transaction used

        The number of times the transaction has been used.

      • getLocalUseCount

        java.lang.Long getLocalUseCount()
        Getter for field LOCALCNT

        Number of times transaction run locally by DTR

        The number of times the dynamic transaction routing exit has chosen to run this transaction on the local system. This value is zero if the transaction was not defined as DYNAMIC=YES.

      • getStorageViolationCount

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

        Number of storage violations

        The number of storage violations for this transaction that have been detected by CICS storage management.

      • getProfile

        java.lang.String getProfile()
        Getter for field PROFILE

        Transaction profile

        The name of the transaction profile. If the profile is not available, this field will be blank.

      • getResourceSecurity

        ILocalTransaction.ResourceSecurityValue getResourceSecurity()
        Getter for field RESSEC

        Resource level security status

        Indicates the resource security checking option that is in effect for this transaction, as one of the following:

        • RESSECNO - The transaction is not subject to resource security.
        • RESSECYES - The transaction is subject to resource security.

      • getTaskDataLocation

        ILocalTransaction.TaskDataLocationValue getTaskDataLocation()
        Getter for field TASKDATALOC

        Task data location

        Indicates whether certain CICS control blocks for a transaction are acquired above or below the 16MB line (BELOW or ANY).

      • getTaskDataKey

        ILocalTransaction.TaskDataKeyValue getTaskDataKey()
        Getter for field TASKDATAKEY

        Task data key

        The storage key in which CICS obtains all storage for use by the transaction. This includes the task lifetime storage (TWA and EIB) and the storage that CICS obtains on behalf of programs that run under the transaction. The options are CICSDATAKEY and USERDATAKEY:

      • getRouting

        ILocalTransaction.RoutingValue getRouting()
        Getter for field ROUTING

        Routing type

        Indicates whether dynamic routing is defined for this transaction (STATIC or DYNAMIC).

      • getRestartCount

        java.lang.Long getRestartCount()
        Getter for field RESTARTCNT

        Number of times transaction restarted

        The number of times the transaction was restarted after an abend, if the RE CEDA keyword was specified.

      • getRemoteCount

        java.lang.Long getRemoteCount()
        Getter for field REMOTECNT

        Number of times transaction run remotely by DTR

        The number of times the dynamic transaction routing (DTR) exit has chosen to run this transaction on a remote system.

      • getRemoteStartCount

        java.lang.Long getRemoteStartCount()
        Getter for field REMSTARTCNT

        Number of attempted starts on remote system

        The number of attempts to start this transaction on a remote system. This may not be the same as the number of successful starts.

      • getDataIsolation

        ILocalTransaction.DataIsolationValue getDataIsolation()
        Getter for field ISOLATEST

        Transaction isolation type

        Indicates whether the user-key task-lifetime storage is isolated from the user-key programs of other transactions:

        • ISOLATE - The user-key task-lifetime storage is accessible only by the user-key programs of its own task; it is isolated from the user-key programs of all other tasks.
        • NOISOLATE - The user-key task-lifetime storage is accessible by its own programs, and also by user-key programs of other transactions defined with the ISOLATE(NO) option.

      • getRunawayTime

        java.lang.Long getRunawayTime()
        Getter for field RUNAWAY

        Runaway time (milliseconds)

        The amount of time, in milliseconds, that a task is allowed to run using this transaction before it is assumed to be in a runaway condition. When this interval expires the task is abnormally terminated. A value of 0 means that no runaway task detection is required.

      • getRunawayType

        ILocalTransaction.RunawayTypeValue getRunawayType()
        Getter for field RUNAWAYTYPE

        Source of runaway timeout value

        Indicates whether the transaction uses the current system runaway limit or one set by the user:

        • SYSTEM - The current system runaway limit is used.
        • USER - The limit set by the user is used.

      • getShutdown

        ILocalTransaction.ShutdownValue getShutdown()
        Getter for field SHUTDOWN

        Shutdown run status

        Indicates whether this transaction can be executed during CICS shutdown by a task created to process unsolicited input. (The transaction also can be executed in this situation if it appears in the transaction list table (XLT) for shutdown.)

        Options are:

        • SHUTDISABLED - Tasks do not continue to run during shutdown.
        • SHUTENABLED - Tasks continue to run during shutdown.

      • getStorageClearance

        ILocalTransaction.StorageClearanceValue getStorageClearance()
        Getter for field STORAGECLEAR

        Storage clearance status

        Indicates whether the storage for a task associated with this transaction is cleared upon release. Options are CLEAR or NOCLEAR.

      • getTransactionClass

        java.lang.String getTransactionClass()
        Getter for field TRANCLASS

        Transaction class name

        The 8-character name of the transaction class to which this transaction belongs. If the transaction does not belong to any class, the value DFHTCL00 is returned.

      • getRemoteName

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

        Remote transaction name

        The name of the transaction as it is defined to a remote system. If this field is blank, the transaction is not defined on a remote system.

      • getRemoteSystem

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

        Remote system name

        Specifies the name that identifies the intercommunication link on which the transaction attach request is sent.

        • For IPIC connections, the first 4 characters of the IPCONN definition are used.
        • For MRO and APPC connections, the CONNECTION name on the CONNECTION definition is used.
      • getTransactionRoutingProfile

        java.lang.String getTransactionRoutingProfile()
        Getter for field TRPROF

        Transaction routing profile

        The name of the profile for transaction routing.

      • getIndoubtWait

        ILocalTransaction.IndoubtWaitValue getIndoubtWait()
        Getter for field INDOUBTWAIT

        In-doubt wait option

        Indicates whether an indoubt UOW is to wait pending recovery from a failure that occurs after the UOW has entered the indoubt state. The valid values are WAIT and NOWAIT.

      • getIndoubt

        ILocalTransaction.IndoubtValue getIndoubt()
        Getter for field INDOUBT

        Transaction in-doubt option

        Indicates the action to be taken when a CICS region fails or loses connectivity with its coordinator during two-phase commit processing, and the UOW has entered an indoubt state. If WAIT is specified in the Wait Option field, this field has no effect until the wait time expires. The valid values are:

        • BACKOUT - All changes made to recoverable resources are backed out and the resources are returned to the state they were in before the start of the UOW
        • COMMIT - All changes made to recoverable resources are committed and the in-flight UOW is marked as completed.
      • getIndoubtWaitTime

        java.lang.Long getIndoubtWaitTime()
        Getter for field INDOUBTMINS

        In-doubt time (minutes)

        The length of time, in minutes, after a failure during the indoubt period, before the task is to take the action indicated in the indoubt Option field (COMMIT or BACKOUT).

      • getIndoubtWaitCount

        java.lang.Long getIndoubtWaitCount()
        Getter for field NUMINDOUBWT

        Number of in-doubt waits

        Specifies the number of times the transaction has waited, due to a failure, during the in-doubt period.

      • getTransactionForcedActionCount

        java.lang.Long getTransactionForcedActionCount()
        Getter for field FORACTTRNDF

        Forced actions - in-doubt waiting not supported

        The number of forced indoubt action resolutions that have occurred because the transaction definition does not support in-doubt waiting.

      • getTimeoutForcedActionCount

        java.lang.Long getTimeoutForcedActionCount()
        Getter for field FORACTINDTO

        Forced actions - in-doubt timeout value exceeded

        The number of forced in-doubt action resolutions that have occurred because the transaction definition specifies a timeout value for in-doubt waiting and that value was exceeded.

      • getWaitForcedActionCount

        java.lang.Long getWaitForcedActionCount()
        Getter for field FORACTNOWT

        Forced actions - wait not supported for resources

        The number of forced in-doubt action resolutions that have occurred because a recoverable Resource or Resource Manager Coordinator (such as LU6.1, MRO, RMI, DB2, or DBCTL) could not support indoubt waiting.

      • getOperatorForcedActionCount

        java.lang.Long getOperatorForcedActionCount()
        Getter for field FORACTOPER

        Forced actions - operator cancelled wait

        The number of forced in-doubt action resolutions that have occurred because the operator cancelled the wait for in-doubt resolution.

      • getOtherForcedActionCount

        java.lang.Long getOtherForcedActionCount()
        Getter for field FORACTOTHER

        Forced actions - other reasons

        The number of forced in-doubt action resolutions that have occurred for reasons other than those listed in this view

      • getIndoubtActionMismatchCount

        java.lang.Long getIndoubtActionMismatchCount()
        Getter for field ACTMISMATS

        Number of indoubt action mismatches detected

        The number of forced indoubt action resolutions that a participating Resource Manager Coordinator (such as DB2, DBCTL, MRO, LU6.1, LU6.2, or RMI) resolved in the opposite way to CICS for this transaction.

      • getFacilityLike

        java.lang.String getFacilityLike()
        Getter for field FACILITYLIKE

        Model for virtual terminal

        The logical terminal that is associated with this transaction will be built to have the same attributes as the terminal named here, when this transaction is started by the 3270 bridge. If this value is blank and the Profile field is blank, the FACILITYLIKE value could not be determined because the transaction profile was not available.

      • getBridgeExitProgram

        java.lang.String getBridgeExitProgram()
        Getter for field BREXIT

        Bridge exit program name

        The bridge exit associated with this program.

      • getRoutingStatus

        ILocalTransaction.RoutingStatusValue getRoutingStatus()
        Getter for field ROUTESTATUS

        Route status

        The Routing status for this transaction for EXEC CICS START.

        ROUTABLE specifies that this transaction can be dynamically routed by the CICS dynamic routing exit. NOTROUTABLE specifies that it cannot be dynanically routed by the CICS dynamic routing exit.

      • getOTSTimeout

        java.lang.Long getOTSTimeout()
        Getter for field OTSTIMEOUT

        Object transaction service (OTS) timeout (seconds)

        The default period in seconds an OTS transaction created in an EJB environment executing under this CICS transaction will be allowed to execute prior to syncpoint.

      • getChangeAgent

        ILocalTransaction.ChangeAgentValue getChangeAgent()
        Getter for field CHANGEAGENT

        Last 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 - The resource was last changed by a CICSPlex SM BAS API command.
        • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
        • SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
        • CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
        • NOTAPPLIC - This is not applicable for this resource.
        • OVERRIDE - Resource was last changed by resource overrides.
        • N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
      • getChangeUserID

        java.lang.String getChangeUserID()
        Getter for field CHANGEUSRID

        Last modification user ID

        The user ID that made the last modification to the resource definition.

      • getChangeAgentRelease

        java.lang.String getChangeAgentRelease()
        Getter for field CHANGEAGREL

        Last modification agent release

        The CICS release level of the agent that made the last modification to the resource definition.

      • getInstallAgent

        ILocalTransaction.InstallAgentValue getInstallAgent()
        Getter for field INSTALLAGENT

        Installation agent

        The install agent identifier that made the installation.

        • CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
        • CREATESPI - The resource was installed by an EXEC CICS CREATE command.
        • SYSTEM - The resource was installed by the CICS system.
        • GRPLIST - The resource was installed by GRPLIST INSTALL.
        • BUNDLE - The resource was installed by a bundle deployment.
      • getChangeTime

        java.util.Date getChangeTime()
        Getter for field CHANGETIME

        Last modification time

        The local date and time when the definition was last changed.

      • getDefineSource

        java.lang.String getDefineSource()
        Getter for field DEFINESOURCE

        Source of the resource definition

        The source of the definition, depending on which agent made the last change.

      • getDefineTime

        java.util.Date getDefineTime()
        Getter for field DEFINETIME

        Creation time

        The local date and time when the resource definition record was created on DFHCSD or EYUDREP.

      • getInstallUserID

        java.lang.String getInstallUserID()
        Getter for field INSTALLUSRID

        Installation user ID

        The user ID that installed the resource definition.

      • getInstallTime

        java.util.Date getInstallTime()
        Getter for field INSTALLTIME

        Installation time

        The local date and time when the definition was installed.

      • getBasdefinever

        java.lang.Long getBasdefinever()
        Getter for field BASDEFINEVER

        BAS resource definition version

        The BAS version number of this definition.

      • getApplicationName

        java.lang.String getApplicationName()
        Getter for field APPLICATION

        Application Name

        The application name of the application for which this LOCTRAN resource is defined. If the OPERATION field is set, this resource is defined as an entry point.

      • getPlatformName

        java.lang.String getPlatformName()
        Getter for field PLATFORM

        Platform Name

        The platform name of the application for which this LOCTRAN resource is defined. If the OPERATION field is set, this resource is defined as an entry point.

      • getOperationName

        java.lang.String getOperationName()
        Getter for field OPERATION

        Operation Name

        The name of the application operation for which this LOCTRAN resource is defined as an entry point. If this field is not set, this resource is not defined as an entry point but may still be part of an application.

      • getMajorVersion

        java.lang.Long getMajorVersion()
        Getter for field APPLMAJORVER

        Major Version

        The major version number of the application for which this LOCTRAN resource is defined. If the OPERATION field is set, this resource is defined as an entry point. If this field is set to -1 then the resource is not part of an Application.

      • getMinorVersion

        java.lang.Long getMinorVersion()
        Getter for field APPLMINORVER

        Minor Version

        The minor version number of the application for which this LOCTRAN resource is defined. If the OPERATION field is set, this resource is defined as an entry point. If this field is set to -1 then the resource is not part of an Application.

      • getMicroVersion

        java.lang.Long getMicroVersion()
        Getter for field APPLMICROVER

        Micro Version

        The micro version number of the application for which this LOCTRAN resource is defined. If the OPERATION field is set, this resource is defined as an entry point. If this field is set to -1 then the resource is not part of an Application.

      • getAvailability

        ILocalTransaction.AvailabilityValue getAvailability()
        Getter for field AVAILSTATUS

        Availability status

        The availability of this LOCTRAN resource when an application entry point is in control of the availability.

        • AVAILABLE - The application entry point controlling the availability of this LOCTRAN resource is available.
        • UNAVAILABLE - The application entry point controlling the availability of this LOCTRAN resource is enabled but has not yet been made available.
        • NONE - There are several reasons for NONE availability.
          • This LOCTRAN resource is not part of a CICS Application.
          • No application entry point is controlling the availability of this LOCTRAN resource.
          • The application entry point controlling the availability of this LOCTRAN resource is disabled.
          • The application entry point controlling the availability of this LOCTRAN resource is not resident in the same CICS bundle.
      • getAbendCount

        java.lang.Long getAbendCount()
        Getter for field ABENDCNT

        The number of transaction abends

        The number of times that this transaction has been abended.

      • getPurgeCount

        java.lang.Long getPurgeCount()
        Getter for field PURGECNT

        The number of transaction purges at class threshold

        The number of times that this transaction has been purged because of exceeding transaction class limit.