com.ibm.cics.jcicsx

Interface Channel

  • All Superinterfaces:
    java.lang.Iterable<Container>


    public interface Channel
    extends java.lang.Iterable<Container>
    A CICS channel
    Since CICS TS version:
    5.6
    Since package version:
    1.000.0
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      Copyright
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method and Description
      void delete()
      Deletes this channel and all the containers that are in it
      - Any data in containers is discarded
      - All storage related to the channel and its containers is released
      default boolean exists()
      Determines if this channel exists in CICS
      BITContainer getBITContainer(java.lang.String containerName)
      Get a container of BIT type, i.e.
      CHARContainer getCHARContainer(java.lang.String containerName)
      Get a container of CHAR type, i.e.
      int getContainerCount()
      Get the number of containers in this channel
      java.lang.String getName()
      Get the name of this channel
      java.util.Iterator<Container> iterator()
      Returns an iterator over elements of type Container.
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Method Detail

      • getCHARContainer

        CHARContainer getCHARContainer(java.lang.String containerName)
        Get a container of CHAR type, i.e. that deals with character data with an inherent encoding.
        Parameters:
        containerName - The name of the container.
        Returns:
        The container
      • getBITContainer

        BITContainer getBITContainer(java.lang.String containerName)
        Get a container of BIT type, i.e. that deals with bytes directly.
        Parameters:
        containerName - The name of the container.
        Returns:
        The container
      • getName

        java.lang.String getName()
        Get the name of this channel
        Returns:
        the name of the channel.
      • delete

        void delete()
             throws CICSConditionException
        Deletes this channel and all the containers that are in it
        - Any data in containers is discarded
        - All storage related to the channel and its containers is released

        EXEC CICS API commands:

        • EXEC CICS DELETE CHANNEL
        Throws:
        CICSConditionException - if there's a problem deleting the channel.

        RespCodes:

      • iterator

        java.util.Iterator<Container> iterator()
                                        throws CICSConditionRuntimeException
        Returns an iterator over elements of type Container. Note that this throws a CICSConditionRuntimeException on any failures performing the CICS API commands, in order to conform to the Iterable interface. The EXEC CICS commands are executed when creating the iterator, the data in the iterator should be considered representative of the state within CICS when the iterator was constructed. Methods on the returned Iterator do not throw any CICS-specific exceptions.

        EXEC CICS API commands:

        • EXEC CICS STARTBROWSE CONTAINER
        • EXEC CICS GETNEXT CONTAINER
        • EXEC CICS ENDBROWSE CONTAINER
        Specified by:
        iterator in interface java.lang.Iterable<Container>
        Returns:
        an Iterator
        Throws:
        CICSConditionRuntimeException - if there is a problem getting the information from CICS

        RespCodes: