Interface IWorkloadAffinity
-
- All Superinterfaces:
ICICSObject
,ICPSMManager
,com.ibm.cics.model.meta.ITypedObject
public interface IWorkloadAffinity extends ICPSMManager
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IWorkloadAffinity.AffinityValue
Enumeration type for field AFFINITYstatic class
IWorkloadAffinity.LifetimeValue
Enumeration type for field LIFETIME
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICPSMManager
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IWorkloadAffinity.AffinityValue
getAffinity()
Getter for field AFFINITYjava.lang.String
getAffinityKey()
Getter for field AFFKEYjava.lang.String
getBtsActivityID()
Getter for field CBTSKEYjava.lang.String
getCbtsActivityID()
Getter for field RESERVD2IWorkloadAffinityReference
getCICSObjectReference()
IWorkloadAffinity.LifetimeValue
getLifetime()
Getter for field LIFETIMEjava.lang.String
getLocalUOWID()
Getter for field LOCUOWIDjava.lang.String
getLuName()
Getter for field LUNAMEjava.lang.String
getNetworkUOWID()
Getter for field NETUOWIDICICSType<IWorkloadAffinity>
getObjectType()
java.lang.String
getRoutingRegion()
Getter for field TORNAMEjava.lang.String
getTargetRegion()
Getter for field AORjava.lang.String
getTerminalId()
Getter for field TERMIDjava.lang.String
getTransactionGroup()
Getter for field TRANGRPjava.lang.String
getUserId()
Getter for field USERIDjava.lang.String
getWorkload()
Getter for field WORKLOADjava.lang.String
getWorkloadOwner()
Getter for field WRKLOWNER-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
Methods inherited from interface com.ibm.cics.model.ICPSMManager
getCICSContainer
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IWorkloadAffinity> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceICPSMManager
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getTransactionGroup
java.lang.String getTransactionGroup()
Getter for field TRANGRPTransaction group
The name of an active transaction group. A value of $$DTGA$$ represents the default transaction group, which is used for any transactions that are not associated with a transaction group.
-
getWorkload
java.lang.String getWorkload()
Getter for field WORKLOADWorkload name
The name of the workload in which the transaction group is active.
-
getAffinity
IWorkloadAffinity.AffinityValue getAffinity()
Getter for field AFFINITYAffinity relationship
The affinity relationship used when processing a transaction associated with the transaction group. The affinity relationship values are:
- GLOBAL - All users at all terminals.
- LUNAME - Terminal logical unit name.
- USERID - User ID.
- BAPPL - CICS BTS Business application.
- Locked - LOCKED affinities can arise only between dynamically linked programs. A LOCKED affinity is created when a called program retains state data that is to be preserved after returning to its caller. Programs with this type of affinity are routed to the same target region until end of unit of work occurs. LOCKED can be used only for dynamic program link (DPL) requests with an associated affinity lifetime of UOW.
- NONE - No affinity relation was defined.
-
getLifetime
IWorkloadAffinity.LifetimeValue getLifetime()
Getter for field LIFETIMEAffinity lifetime
The affinity lifetime used when processing a transaction associated with the transaction group. The affinity lifetime values are:
- DELIMIT - Until the pseudoconversation mode is END.
- LOGON - For the duration of the terminal session.
- NONE - No affinity lifetime was defined.
- PCONV - For the duration of the pseudoconversation.
- PERMANENT - As long as the workload is active.
- SIGNON - As long as the user session is active.
- SYSTEM - As long as the target region is active.
- ACTIVITY - As long as the CICS BTS activity is active.
- PROCESS - As long as the CICS BTS process is active.
- UOW - For as long as the unit-of-work is active
-
getUserId
java.lang.String getUserId()
Getter for field USERIDUser identifier
The user identifier ID.
-
getLuName
java.lang.String getLuName()
Getter for field LUNAMETerminal LU name
The logical unit name of the terminal of the CICS system to which transactions associated with the transaction group are to be routed.
-
getRoutingRegion
java.lang.String getRoutingRegion()
Getter for field TORNAMERouting region
The name of the CICS system to which transactions associated with the transaction group are to be routed.
-
getTerminalId
java.lang.String getTerminalId()
Getter for field TERMIDRouting region terminal
The terminal ID of the CICS system to which transactions associated with the transaction group are to be routed.
-
getCbtsActivityID
java.lang.String getCbtsActivityID()
Getter for field RESERVD2The activity ID of the CBTS activity
The ID of the CBTS activity.
-
getTargetRegion
java.lang.String getTargetRegion()
Getter for field AORTarget region
The name of the CICS system to which transactions associated with the transaction group are to be routed.
-
getWorkloadOwner
java.lang.String getWorkloadOwner()
Getter for field WRKLOWNERSystem ID of workload owner
The 4-character CICS system ID of the CMAS that created the workload.
-
getBtsActivityID
java.lang.String getBtsActivityID()
Getter for field CBTSKEYBTS activity ID
The hexadecimal representation of the Affinity Key. It is shown in this additional format because part of the key may not be displayable in normal character representation.
-
getLocalUOWID
java.lang.String getLocalUOWID()
Getter for field LOCUOWIDLocal unit-of-work ID
The hexadecimal representation of the CICS local unit-of-work identifier. It is shown in this additional format because part of the key may not be displayable in normal character representation.
-
getNetworkUOWID
java.lang.String getNetworkUOWID()
Getter for field NETUOWIDNetwork unit-of-work ID
The hexadecimal representation of the CICS network unit-of-work identifier. It is shown in this additional format because part of the key may not be displayable in normal character representation.
-
getAffinityKey
java.lang.String getAffinityKey()
Getter for field AFFKEYKey that identifies creator of affinity
Up to 64 characters identifying who invoked a transaction, comprising the transaction group and their location. Depending on the affinity relation and lifetime values, this key will be some combination of the user ID, logical unit name, routing region name, and terminal ID, in the following format: userid.luname.rtrname.termid. If one or more of these values does not apply to the affinity, that part of the key is left blank.
For BAPPL affinities, this field contains the Activity ID of the CICS BTS activity.
For LOCKED affinities, this field contains the combination of the routing region name with the network and local unit-of-work identifiers.
A value of GA is displayed for global affinities.
-
getCICSObjectReference
IWorkloadAffinityReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICPSMManager
-
-