com.ibm.cics.server

Class DocumentLocation

  • java.lang.Object
    • com.ibm.cics.server.DocumentLocation


  • public class DocumentLocation
    extends java.lang.Object

    This Class provides a wrapper for the AT and TO keywords for CICS DOCUMENT API command DOCUMENT INSERT.

    The AT keyword gives the name of the bookmark which identifies the position of the insertion point in the document at which data can be inserted.

    The TO keyword gives the name of the bookmark identifying the end position of an overlay operation. Data can be overlayed between the AT and TO bookmarks.

    The constructors accept the AT bookmark or both the AT and TO bookmarks. Protected getters are provided to retrieve the AT and TO bookmarks.

    Since CICS TS version:
    2.3
    Since package version:
    1.0.0
    • Constructor Summary

      Constructors 
      Constructor and Description
      DocumentLocation(java.lang.String Iat)
      Public constructor which accepts an AT string.
      DocumentLocation(java.lang.String Iat, java.lang.String Ito)
      Public constructor which accepts an AT string and TO string.
    • Method Summary

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DocumentLocation

        public DocumentLocation(java.lang.String Iat)
        Public constructor which accepts an AT string.

        Parameters:
        Iat - contains the name of the AT bookmark
        Since CICS TS version:
        2.3
        Since package version:
        1.0.0
      • DocumentLocation

        public DocumentLocation(java.lang.String Iat,
                                java.lang.String Ito)
        Public constructor which accepts an AT string and TO string.

        Parameters:
        Iat - contains the name of the AT bookmark
        Ito - contains the name of the TO bookmark
        Since CICS TS version:
        2.3
        Since package version:
        1.0.0