INQUIRE ASSOCIATION

Syntax

ibmCics.inquireAssociation(new InquireAssociationOptions()
  .eibTaskn(<EibTaskn>)
  [.applicationContextApplicationName(<ApplicationContextApplicationName>)]
  [.applicationContextMajorVersion(<ApplicationContextMajorVersion>)]
  [.applicationContextMicroVersion(<ApplicationContextMicroVersion>)]
  [.applicationContextMinorVersion(<ApplicationContextMinorVersion>)]
  [.applicationContextOperName(<ApplicationContextOperName>)]
  [.applicationContextPlatformName(<ApplicationContextPlatformName>)]
  [.applicationData(<ApplicationData>)]
  [.applicationId(<ApplicationId>)]
  [.clientIpAddr(<ClientIpAddr>)]
  [.clientLoc(<ClientLoc>)]
  [.clientPort(<ClientPort>)]
  [.clntIpFamily(<ClntIpFamily>)]
  [.distinguishedName(<DistinguishedName>)]
  [.facilityName(<FacilityName>)]
  [.facilityType(<FacilityType>)]
  [.initUserId(<InitUserId>)]
  [.ipConn(<IpConn>)]
  [.ipFamily(<IpFamily>)]
  [.luName(<LuName>)]
  [.mvsImage(<MvsImage>)]
  [.netId(<NetId>)]
  [.originDataAdapterId(<OriginDataAdapterId>)]
  [.originDataAdapterData1(<OriginDataAdapterData1>)]
  [.originDataAdapterData2(<OriginDataAdapterData2>)]
  [.originDataAdapterData3(<OriginDataAdapterData3>)]
  [.originDataApplicationId(<OriginDataApplicationId>)]
  [.originDataClientIpAddr(<OriginDataClientIpAddr>)]
  [.originDataClientPort(<OriginDataClientPort>)]
  [.originDataFacilityName(<OriginDataFacilityName>)]
  [.originDataFacilityType(<OriginDataFacilityType>)]
  [.originDataIpFamily(<OriginDataIpFamily>)]
  [.originDataLuName(<OriginDataLuName>)]
  [.originDataNetId(<OriginDataNetId>)]
  [.originDataNetworkId(<OriginDataNetworkId>)]
  [.originDataServerPort(<OriginDataServerPort>)]
  [.originDataStartTime(<OriginDataStartTime>)]
  [.originDataTaskId(<OriginDataTaskId>)]
  [.originDataTcpIps(<OriginDataTcpIps>)]
  [.originDataTransId(<OriginDataTransId>)]
  [.originDataUserId(<OriginDataUserId>)]
  [.previousHopApplicationId(<PreviousHopApplicationId>)]
  [.previousHopCount(<PreviousHopCount>)]
  [.previousHopNetworkId(<PreviousHopNetworkId>)]
  [.previousHopStartTime(<PreviousHopStartTime>)]
  [.previousHopTaskId(<PreviousHopTaskId>)]
  [.previousHopTransId(<PreviousHopTransId>)]
  [.program(<Program>)]
  [.previousTransactionCount(<PreviousTransactionCount>)]
  [.previousTransactionStartTime(<PreviousTransactionStartTime>)]
  [.previousTransactionTaskId(<PreviousTransactionTaskIdtId>)]
  [.previousTransactionTransId(<PreviousTransactionTransId>)]
  [.realm(<Realm>)]
  [.serverIpAddr(<ServerIpAddr>)]
  [.serverPort(<ServerPort>)]
  [.serverIpFamily(<ServerIpFamily>)]
  [.startTime(<StartTime>)]
  [.tcpIpJob(<TcpIpJob>)]
  [.tcpIpService(<TcpIpService>)]
  [.tcpIpZone(<TcpIpZone>)]
  [.transactionGroupId(<TransactionGroupId>)]
  [.transaction(<Transaction>)]
  [.userCorrelatorData(<UserCorrelatorData>)]
  [.userId(<UserId>)]
  [.noHandle(true)]
);

Parameter(s)

<EibTaskn>
The task number.
<ApplicationContextApplicationName>
The variable where the application name of the task will be stored.
<ApplicationContextMajorVersion>
Not currently used in AMT, returns 0.
<ApplicationContextMicroVersion>
Not currently used in AMT, returns 0.
<ApplicationContextMinorVersion>
Not currently used in AMT, returns 0.
<ApplicationContextOperName>
Not currently used in AMT, returns an empty string.
<ApplicationContextPlatformName>
Not currently used in AMT, returns an empty string.
<ApplicationData>
Not currently used in AMT, returns an empty string.
<ApplicationId>
The variable where the application ID of the task will be stored.
<ClientIpAddr>
The variable where the client IP address who started the task will be stored, in AMT this will be '0.0.0.0'.
<ClientLoc>
Not currently used in AMT, returns an empty string.
<ClientPort>
Not currently used in AMT, returns 0.
<ClntIpFamily>
The variable where the form of TCP/IP addressing of the task will be stored, in AMT this will be the value for 'NOTAPPLIC'.
<DistinguishedName>
Not currently used in AMT, returns an empty string.
<FacilityName>
Not currently used in AMT, returns an empty string.
<FacilityType>
Not used in AMT, returns the CVDA value of 'NONE'.
<InitUserId>
The variable where the user name of the task initiator will be stored.
<IpConn>
Not currently used in AMT, returns an empty string.
<IpFamily>
The variable where the form of TCP/IP addressing of the task will be stored, in AMT this will be the value for 'NOTAPPLIC'.
<LuName>
The variable where the station name of the task initiator will be stored.
<MvsImage>
Not currently used in AMT, returns an empty string.
<NetId>
The variable where the terminal ID of the task will be stored.
<OriginDataAdapterId>
Not currently used in AMT, returns an empty string.
<OriginDataAdapterData1>
Not currently used in AMT, returns an empty string.
<OriginDataAdapterData2>
Not currently used in AMT, returns an empty string.
<OriginDataAdapterData3>
Not currently used in AMT, returns an empty string.
<OriginDataApplicationId>
The variable where the application ID of the task will be stored.
<OriginDataClientIpAddr>
The variable where the client IP address who started the task will be stored, in AMT this will be '0.0.0.0'.
<OriginDataClientPort>
Not currently used in AMT, returns 0.
<OriginDataFacilityName>
Not currently used in AMT, returns an empty string.
<OriginDataFacilityType>
Not used in AMT, returns the CVDA value of 'NONE'.
<OriginDataIpFamily>
The variable where the form of TCP/IP addressing of the task will be stored, in AMT this will be the value for 'NOTAPPLIC'.
<OriginDataLuName>
The variable where the station name of the task initiator will be stored.
<OriginDataNetId>
The variable where the terminal ID of the task will be stored.
<OriginDataNetworkId>
Not currently used in AMT, returns an empty string.
<OriginDataServerPort>
Not currently used in AMT, returns 0.
<OriginDataStartTime>
The variable where the start time of the task will be stored.
<OriginDataTaskId>
Not currently used in AMT, returns 0.
<OriginDataTcpIps>
Not currently used in AMT, returns an empty string.
<OriginDataTransId>
Not currently used in AMT, returns 0.
<OriginDataUserId>
The variable where the user name of the task initiator will be stored.
<PreviousHopApplicationId>
Not currently used in AMT, returns an empty string.
<PreviousHopCount>
Not currently used in AMT, returns 0.
<PreviousHopNetworkId>
Not currently used in AMT, returns an empty string.
<PreviousHopStartTime>
Not currently used in AMT, returns an empty string.
<PreviousHopTaskId>
Not currently used in AMT, returns 0.
<PreviousHopTransId>
Not currently used in AMT, returns an empty string.
<Program>
The variable where the program name that initiated the task will be stored..
<PreviousTransactionCount>
Not currently used in AMT, returns 0.
<PreviousTransactionStartTime>
Not currently used in AMT, returns an empty string.
<PreviousTransactionTaskId>
Not currently used in AMT, returns an empty string.
<PreviousTransactionTransId>
Not currently used in AMT, returns an empty string.
<Realm>
Not currently used in AMT, returns an empty string.
<ServerIpAddr>
The variable where the server IP address that scheduled the task will be stored, in AMT this will be '0.0.0.0'.
<ServerPort>
Not currently used in AMT, returns 0.
<ServerIpFamily>
The variable where the form of TCP/IP addressing of the task will be stored, in AMT this will be the value 'NOTAPPLIC'.
<StartTime>
The variable where the start time of the task will be stored.
<TcpIpJob>
Not currently used in AMT, returns an empty string.
<TcpIpService>
Not currently used in AMT, returns an empty string.
<TcpIpZone>
Not currently used in AMT, returns an empty string.
<TransactionGroupId>
Not currently used in AMT, returns an empty string.
<Transaction>
The variable where the transaction ID of the task will be stored.
<UserCorrelatorData>
Not currently used in AMT, returns an empty string.
<UserId>
The variable where the user name of the task initiator will be stored.
noHandle
Optional Boolean. If set to true, exceptions created by this command will be ignored.

Example(s)

EXEC CICS
    INQUIRE ASSOCIATION (WS-TASK)
        APPLID (WS-APPID)
        TRANSACTION (WS-TRANSACTION)
        USERID (WS-USERID)
END-EXEC.
                

ibmCics.inquireAssociation(new InquireAssociationOptions()
  .eibTaskn(locDef.ws_Task)
  .applicationId(locDef.ws_Appid)
  .transaction(locDef.ws_Transaction)
  .userId(locDef.ws_Userid)
);