public interface ChannelProgramLinkerResponse extends ProgramLinkerResponse
A ChannelProgramLinkerResponse
is returned when a program is
linked to using ChannelProgramLinker.link()
.
This class offers a set of convenience methods that allow the response from the link to be introspected, by reading data from containers in the channel that was used as the current channel of the linked program.
These methods are shortcuts for similar methods on the main
Channel
and Container
classes.
Modifier and Type | Method and Description |
---|---|
default byte[] |
getBytesOutput(java.lang.String containerName)
Convenience method for reading a named string from a named CHAR container.
|
Channel |
getChannel()
Get the Channel that was used by the
ChannelProgramLinker that
constructed this response, i.e. |
default ReadableBITContainer |
getOutputBITContainer(java.lang.String containerName)
Get a named container to use for reading binary data output.
|
default ReadableCHARContainer |
getOutputCHARContainer(java.lang.String containerName)
Get a named container to use for reading character data output.
|
default java.lang.String |
getStringOutput(java.lang.String containerName)
Convenience method for reading a named string from a named CHAR container.
|
Channel getChannel()
ChannelProgramLinker
that
constructed this response, i.e. the current channel of the program
that was linked to.default ReadableBITContainer getOutputBITContainer(java.lang.String containerName) throws CICSConditionException
Channel.getBITContainer(String)
for RespCode
information.containerName
- Name of the containerReadableBITContainer
that can be used to get binary data output
from a programCICSConditionException
- if there's a problem getting the container.
See Channel.getBITContainer(String)
for RespCode
information.default ReadableCHARContainer getOutputCHARContainer(java.lang.String containerName) throws CICSConditionException
Channel.getCHARContainer(String)
for RespCode
information.containerName
- Name of the containerReadableCHARContainer
that can be used to get character data output
from a programCICSConditionException
- if there's a problem getting the container.
See Channel.getCHARContainer(String)
for RespCode
information.default java.lang.String getStringOutput(java.lang.String containerName) throws CICSConditionException
getOutputCHARContainer(String)
and ReadableCHARContainer.get()
for
EXEC CICS
API command and RespCode
information.containerName
- Name of the container to useCICSConditionException
- if there's a problem getting the container or reading from it.
See getOutputCHARContainer(String)
and ReadableCHARContainer.get()
for
EXEC CICS
API command and RespCode
information.default byte[] getBytesOutput(java.lang.String containerName) throws CICSConditionException
getOutputBITContainer(String)
and ReadableBITContainer.get()
for
EXEC CICS
API command and RespCode
information.containerName
- Name of the container to useCICSConditionException
- if there's a problem getting the container or reading from it.
See getOutputBITContainer(String)
and ReadableBITContainer.get()
for
EXEC CICS
API command and RespCode
information.