public interface ProgramLinker
Channel and its
associated Containers, see ChannelProgramLinker| Modifier and Type | Method and Description |
|---|---|
ProgramLinkerResponse |
link()
Link to another program expecting return.
|
ProgramLinker |
setSyncOnReturn(boolean syncOnReturn)
Specifies that the server region named on the SYSID option is to take a sync
point on successful completion of the server program.
|
ProgramLinker |
setSysId(java.lang.String sysId)
Specify the system name of a CICS server region to where the program link
request is to be routed.
|
ProgramLinker |
setTransId(java.lang.String transId)
Specifies the name of the mirror transaction that the remote region is to
attach and under which it is to run the server program.
|
ProgramLinkerResponse link() throws CICSConditionException
EXEC CICS API commands:
EXEC CICS LINK PROGRAMCICSConditionException - if there is a problem linking to the target
program
RespCodes:
ProgramLinker setSyncOnReturn(boolean syncOnReturn)
A CICSConditionException with a RespCode.ROLLEDBACK is thrown
by link() if changes to recoverable resources are rolled back before
return from the server program.
A CICSConditionException with a RespCode.TERMERR is thrown by
link() following failure of the communications link or the system in
which the server program is running. Programs are responsible for handling
this condition and ensuring that data consistency is restored.
syncOnReturn - Whether to take a syncpoint after the target program has
been invoked. The default value is falseProgramLinker instanceProgramLinker setSysId(java.lang.String sysId)
A remote system name specified on the SYSID option takes priority over any remote system name specified on the PROGRAM resource definition or returned by the dynamic routing program.
sysId - Specifies the system name of a CICS server region to where the
program link request is to be routedProgramLinker instanceProgramLinker setTransId(java.lang.String transId)
If you omit the TRANSID option, reference is made to PROGRAM resource definitions held locally if the installed PROGRAM definition specifies remote attribute DYNAMIC(YES). Otherwise, the server region attaches either CSMI, CPMI, or CVMI by default.
transId - Specifies the name of the mirror transaction that the remote
region is to attach and under which it is to run the server
programProgramLinker instance