Interface IRemoteTransaction
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,IInstalledCICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface IRemoteTransaction extends ICICSResource, IInstalledCICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IRemoteTransaction.AvailabilityValue
Enumeration type for field AVAILSTATUSstatic class
IRemoteTransaction.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
IRemoteTransaction.InstallAgentValue
Enumeration type for field INSTALLAGENTstatic class
IRemoteTransaction.PurgeabilityValue
Enumeration type for field PURGEABILITYstatic class
IRemoteTransaction.RoutingValue
Enumeration type for field ROUTINGstatic class
IRemoteTransaction.ScreenSizeValue
Enumeration type for field SCRNSIZE
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getApplicationName()
Getter for field APPLICATIONIRemoteTransaction.AvailabilityValue
getAvailability()
Getter for field AVAILSTATUSjava.lang.Long
getBasdefinever()
Getter for field BASDEFINEVERIRemoteTransaction.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTjava.lang.String
getChangeAgentRelease()
Getter for field CHANGEAGRELjava.util.Date
getChangeTime()
Getter for field CHANGETIMEjava.lang.String
getChangeUserID()
Getter for field CHANGEUSRIDIRemoteTransactionReference
getCICSObjectReference()
java.lang.String
getDefineSource()
Getter for field DEFINESOURCEjava.util.Date
getDefineTime()
Getter for field DEFINETIMEIRemoteTransaction.InstallAgentValue
getInstallAgent()
Getter for field INSTALLAGENTjava.util.Date
getInstallTime()
Getter for field INSTALLTIMEjava.lang.String
getInstallUserID()
Getter for field INSTALLUSRIDjava.lang.Long
getMajorVersion()
Getter for field APPLMAJORVERjava.lang.Long
getMicroVersion()
Getter for field APPLMICROVERjava.lang.Long
getMinorVersion()
Getter for field APPLMINORVERjava.lang.String
getName()
Getter for field TRANIDICICSType<IRemoteTransaction>
getObjectType()
java.lang.String
getOperationName()
Getter for field OPERATIONjava.lang.String
getPlatformName()
Getter for field PLATFORMjava.lang.Long
getPriority()
Getter for field PRIORITYjava.lang.String
getProfile()
Getter for field PROFILEIRemoteTransaction.PurgeabilityValue
getPurgeability()
Getter for field PURGEABILITYjava.lang.Long
getReadTimeout()
Getter for field RTIMEOUTjava.lang.String
getRemoteName()
Getter for field REMOTENAMEjava.lang.Long
getRemoteStartCount()
Getter for field REMSTARTCNTjava.lang.String
getRemoteSystem()
Getter for field REMOTESYSTEMjava.lang.Long
getRemoteUseCount()
Getter for field REMOTECNTIRemoteTransaction.RoutingValue
getRouting()
Getter for field ROUTINGIRemoteTransaction.ScreenSizeValue
getScreenSize()
Getter for field SCRNSIZEICICSEnums.EnablementValue
getStatus()
Getter for field STATUSjava.lang.String
getTransactionClass()
Getter for field TRANCLASSjava.lang.String
getTransactionRoutingProfile()
Getter for field TRPROFjava.lang.Long
getUseCount()
Getter for field USECOUNT-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IRemoteTransaction> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field TRANIDTransaction ID
The name of the transaction as known to the local CICS system.
- Specified by:
getName
in interfaceICICSObject
-
getRemoteName
java.lang.String getRemoteName()
Getter for field REMOTENAMERemote transaction ID
The name by which this transaction is known in the remote system.
-
getRemoteSystem
java.lang.String getRemoteSystem()
Getter for field REMOTESYSTEMRemote 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.
-
getProfile
java.lang.String getProfile()
Getter for field PROFILEProfile name
The name of the profile for the transaction.
-
getTransactionRoutingProfile
java.lang.String getTransactionRoutingProfile()
Getter for field TRPROFName of transaction-routing-session profile
The name of the profile for transaction routing. If this field is blank, the profile is not available.
-
getRouting
IRemoteTransaction.RoutingValue getRouting()
Getter for field ROUTINGRouting status
Indicates whether dynamic routing is defined for this transaction. Options are STATIC or DYNAMIC.
-
getRemoteUseCount
java.lang.Long getRemoteUseCount()
Getter for field REMOTECNTNumber of times transaction run remotely
The number of times the dynamic transaction routing exit chose to run this transaction on a remote system. A value of 0 means the transaction was not defined as DYNAMIC=YES.
-
getUseCount
java.lang.Long getUseCount()
Getter for field USECOUNTNumber of times transaction has been used
The number of times the transaction has been used.
-
getPriority
java.lang.Long getPriority()
Getter for field PRIORITYTransaction priority
The priority of this transaction relative to other transactions in the CICS system.
Input Values: 1 - 255
-
getPurgeability
IRemoteTransaction.PurgeabilityValue getPurgeability()
Getter for field PURGEABILITYPurgeability status
Indicates whether the transaction is purgeable in system stall conditions.
Input Values: PURGEABLE, NOTPURGEABLE
-
getReadTimeout
java.lang.Long getReadTimeout()
Getter for field RTIMEOUTRead 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
IRemoteTransaction.ScreenSizeValue getScreenSize()
Getter for field SCRNSIZEScreen 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 STATUSEnabled status
The enabled status of the transaction, which indicates whether it is available for use.
Input Values: ENABLED, DISABLED
-
getTransactionClass
java.lang.String getTransactionClass()
Getter for field TRANCLASSTransaction class name
The 8-character transaction class name.
-
getRemoteStartCount
java.lang.Long getRemoteStartCount()
Getter for field REMSTARTCNTNumber of times transaction started
The number of times this transaction was started.
-
getChangeAgent
IRemoteTransaction.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 - 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 CHANGEUSRIDLast modification user ID
The user ID that made the last modification to the resource definition.
-
getChangeAgentRelease
java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGRELLast modification agent release
The CICS release level of the agent that made the last modification to the resource definition.
-
getInstallAgent
IRemoteTransaction.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENTInstallation 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 CHANGETIMELast modification time
The local date and time when the definition was last changed.
-
getDefineSource
java.lang.String getDefineSource()
Getter for field DEFINESOURCESource 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 DEFINETIMECreation 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 INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
getInstallTime
java.util.Date getInstallTime()
Getter for field INSTALLTIMEInstallation time
The local date and time when the definition was installed.
-
getBasdefinever
java.lang.Long getBasdefinever()
Getter for field BASDEFINEVERBAS resource definition version
The BAS version number of this definition.
-
getApplicationName
java.lang.String getApplicationName()
Getter for field APPLICATIONApplication Name
The application name of the application for which this REMTRAN 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 PLATFORMPlatform Name
The platform name of the application for which this REMTRAN 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 OPERATIONOperation Name
The name of the application operation for which this REMTRAN 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 APPLMAJORVERMajor Version
The major version number of the application for which this REMTRAN 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 APPLMINORVERMinor Version
The minor version number of the application for which this REMTRAN 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 APPLMICROVERMicro Version
The micro version number of the application for which this REMTRAN 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
IRemoteTransaction.AvailabilityValue getAvailability()
Getter for field AVAILSTATUSAvailability status
The availability of this REMTRAN resource when an application entry point is in control of the availability.
- AVAILABLE - The application entry point controlling the availability of this REMTRAN resource is available.
- UNAVAILABLE - The application entry point controlling the availability of this REMTRAN resource is enabled but has not yet been made available.
- NONE - There are several reasons for NONE availability.
- This REMTRAN resource is not part of a CICS Application.
- No application entry point is controlling the availability of this REMTRAN resource.
- The application entry point controlling the availability of this REMTRAN resource is disabled.
- The application entry point controlling the availability of this REMTRAN resource is not resident in the same CICS bundle.
-
getCICSObjectReference
IRemoteTransactionReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-