com.ibm.cics.server
Class DocumentLocation

java.lang.Object
  extended bycom.ibm.cics.server.DocumentLocation

public class DocumentLocation
extends java.lang.Object

Usage:
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.


Constructor Summary
DocumentLocation(java.lang.String Iat)
          Usage:
Public constructor which accepts an AT string.
DocumentLocation(java.lang.String Iat, java.lang.String Ito)
          Usage:
Public constructor which accepts an AT string and TO string.
 
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)
Usage:
Public constructor which accepts an AT string.

Parameters:
Iat - contains the name of the AT bookmark
Throws:
None

DocumentLocation

public DocumentLocation(java.lang.String Iat,
                        java.lang.String Ito)
Usage:
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
Throws:
None