com.ibm.cics.model
Interface ILocalTransaction

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource, com.ibm.cics.model.meta.ITypedObject

public interface ILocalTransaction
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable LOCTRAN


Nested Class Summary
static class ILocalTransaction.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class ILocalTransaction.CommandSecurityValue
          Enumeration type for field CMDSEC
static class ILocalTransaction.DataIsolationValue
          Enumeration type for field ISOLATEST
static class ILocalTransaction.DumpingValue
          Enumeration type for field DUMPING
static class ILocalTransaction.IndoubtValue
          Enumeration type for field INDOUBT
static class ILocalTransaction.IndoubtWaitValue
          Enumeration type for field INDOUBTWAIT
static class ILocalTransaction.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class ILocalTransaction.PurgeabilityValue
          Enumeration type for field PURGEABILITY
static class ILocalTransaction.ResourceSecurityValue
          Enumeration type for field RESSEC
static class ILocalTransaction.RoutingStatusValue
          Enumeration type for field ROUTESTATUS
static class ILocalTransaction.RoutingValue
          Enumeration type for field ROUTING
static class ILocalTransaction.RunawayTypeValue
          Enumeration type for field RUNAWAYTYPE
static class ILocalTransaction.ScreenSizeValue
          Enumeration type for field SCRNSIZE
static class ILocalTransaction.ShutdownValue
          Enumeration type for field SHUTDOWN
static class ILocalTransaction.StorageClearanceValue
          Enumeration type for field STORAGECLEAR
static class ILocalTransaction.TaskDataKeyValue
          Enumeration type for field TASKDATAKEY
static class ILocalTransaction.TaskDataLocationValue
          Enumeration type for field TASKDATALOC
static class ILocalTransaction.TracingValue
          Enumeration type for field TRACING
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
 
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,ILocalTransaction> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 java.lang.String getBridgeExitProgram()
          Getter for field BREXIT
 ILocalTransaction.ChangeAgentValue getChangeAgent()
          Getter for field CHANGEAGENT
 java.lang.String getChangeAgentRelease()
          Getter for field CHANGEAGREL
 java.util.Date getChangeTime()
          Getter for field CHANGETIME
 java.lang.String getChangeUserID()
          Getter for field CHANGEUSRID
 ILocalTransactionReference getCICSObjectReference()
           
 ILocalTransaction.CommandSecurityValue getCommandSecurity()
          Getter for field CMDSEC
 ILocalTransaction.DataIsolationValue getDataIsolation()
          Getter for field ISOLATEST
 java.lang.Long getDeadlockTimeout()
          Getter for field DTIMEOUT
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 ILocalTransaction.DumpingValue getDumping()
          Getter for field DUMPING
 java.lang.String getFacilityLike()
          Getter for field FACILITYLIKE
 ILocalTransaction.IndoubtValue getIndoubt()
          Getter for field INDOUBT
 java.lang.Long getIndoubtActionMismatchCount()
          Getter for field ACTMISMATS
 ILocalTransaction.IndoubtWaitValue getIndoubtWait()
          Getter for field INDOUBTWAIT
 java.lang.Long getIndoubtWaitCount()
          Getter for field NUMINDOUBWT
 java.lang.Long getIndoubtWaitTime()
          Getter for field INDOUBTMINS
 ILocalTransaction.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 java.lang.Long getLocalUseCount()
          Getter for field LOCALCNT
 java.lang.String getName()
          Getter for field TRANID
 ICICSType<ILocalTransaction> getObjectType()
           
 java.lang.Long getOperatorForcedActionCount()
          Getter for field FORACTOPER
 java.lang.Long getOtherForcedActionCount()
          Getter for field FORACTOTHER
 java.lang.Long getOTSTimeout()
          Getter for field OTSTIMEOUT
 java.lang.Long getPriority()
          Getter for field PRIORITY
 java.lang.String getProfile()
          Getter for field PROFILE
 java.lang.String getProgram()
          Getter for field PROGRAM
 ILocalTransaction.PurgeabilityValue getPurgeability()
          Getter for field PURGEABILITY
 java.lang.Long getReadTimeout()
          Getter for field RTIMEOUT
 java.lang.Long getRemoteCount()
          Getter for field REMOTECNT
 java.lang.String getRemoteName()
          Getter for field REMOTENAME
 java.lang.Long getRemoteStartCount()
          Getter for field REMSTARTCNT
 java.lang.String getRemoteSystem()
          Getter for field REMOTESYSTEM
 ILocalTransaction.ResourceSecurityValue getResourceSecurity()
          Getter for field RESSEC
 java.lang.Long getRestartCount()
          Getter for field RESTARTCNT
 ILocalTransaction.RoutingValue getRouting()
          Getter for field ROUTING
 ILocalTransaction.RoutingStatusValue getRoutingStatus()
          Getter for field ROUTESTATUS
 java.lang.Long getRunawayTime()
          Getter for field RUNAWAY
 ILocalTransaction.RunawayTypeValue getRunawayType()
          Getter for field RUNAWAYTYPE
 ILocalTransaction.ScreenSizeValue getScreenSize()
          Getter for field SCRNSIZE
 ILocalTransaction.ShutdownValue getShutdown()
          Getter for field SHUTDOWN
 ICICSEnums.EnablementValue getStatus()
          Getter for field STATUS
 ILocalTransaction.StorageClearanceValue getStorageClearance()
          Getter for field STORAGECLEAR
 java.lang.Long getStorageViolationCount()
          Getter for field STGVCNT
 ILocalTransaction.TaskDataKeyValue getTaskDataKey()
          Getter for field TASKDATAKEY
 ILocalTransaction.TaskDataLocationValue getTaskDataLocation()
          Getter for field TASKDATALOC
 java.lang.Long getTimeoutForcedActionCount()
          Getter for field FORACTINDTO
 ILocalTransaction.TracingValue getTracing()
          Getter for field TRACING
 java.lang.String getTransactionClass()
          Getter for field TRANCLASS
 java.lang.Long getTransactionForcedActionCount()
          Getter for field FORACTTRNDF
 java.lang.String getTransactionRoutingProfile()
          Getter for field TRPROF
 java.lang.Long getTWASize()
          Getter for field TWASIZE
 java.lang.Long getUseCount()
          Getter for field USECOUNT
 java.lang.Long getWaitForcedActionCount()
          Getter for field FORACTNOWT
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

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

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:


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:


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:


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:


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.


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:


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.


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.


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.


getCICSObjectReference

ILocalTransactionReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,ILocalTransaction> 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.