Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAnnotationDL

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKAnnotationDL
All Implemented Interfaces:
dkAnnotationExt, dkExtension, java.io.Serializable

public class DKAnnotationDL
extends java.lang.Object
implements dkAnnotationExt, java.io.Serializable

This class is a wrapper of DL ANNOTATIONSTRUCT. The data structure provides information about an annotation affiliated with an object.

See Also:
Serialized Form

Constructor Summary
DKAnnotationDL()
          Constructs a new DKAnnotationDL object.
DKAnnotationDL(DKAnnotationDL aDKAnnotationDL)
          Copy constructor.
DKAnnotationDL(int partId, int pageNumber, short Xcoordinate, short Ycoordinate)
          Constructs a new DKAnnotationDL object with input parameters.
 
Method Summary
 boolean equals(DKAnnotationDL aDKAnnotationDL)
          Compares this object with the parameter object.
 java.lang.String getName()
          Gets the name of this extension object
 int getPageNumber()
          Gets the page number that this annotation object refers to.
 int getPart()
          Gets the part Id of the associated object
 short getX()
          Gets the X coordinate on the page that this annotation object refers to.
 short getY()
          Gets the Y coordinate on the page that this annotation object refers to.
 void setName(java.lang.String extName)
          Sets the name of this extension object
 void setPageNumber(int aPageNumber)
          Sets the page number that this annotation object refers to.
 void setPart(int aPartId)
          Sets the part Id of the associated object, only positive values are valid.
 void setX(short aXcoordinate)
          Sets the X coordinate on the page that this annotation object refers to.
 void setY(short aYcoordinate)
          Sets the Y coordinate on the page that this annotation object refers to.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAnnotationDL

public DKAnnotationDL()
Constructs a new DKAnnotationDL object.

DKAnnotationDL

public DKAnnotationDL(int partId,
                      int pageNumber,
                      short Xcoordinate,
                      short Ycoordinate)
Constructs a new DKAnnotationDL object with input parameters.
Parameters:
partId - the part Id of the associated object
pageNumber - the page number that this annotation object refers to
Xcoordinate - the X coordinate on the page that this annotation object refers to
Ycoordinate - the Y coordinate on the page that this annotation object refers to

DKAnnotationDL

public DKAnnotationDL(DKAnnotationDL aDKAnnotationDL)
Copy constructor.
Method Detail

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets the name of this extension object
Specified by:
getName in interface dkExtension
Returns:
name of this object

setName

public void setName(java.lang.String extName)
             throws java.lang.Exception
Sets the name of this extension object
Specified by:
setName in interface dkExtension
Parameters:
extName - name of this extension object

setPageNumber

public void setPageNumber(int aPageNumber)
Sets the page number that this annotation object refers to.
Specified by:
setPageNumber in interface dkAnnotationExt
Parameters:
aPageNumber - a page number

getPageNumber

public int getPageNumber()
Gets the page number that this annotation object refers to.
Specified by:
getPageNumber in interface dkAnnotationExt
Returns:
the page number

setX

public void setX(short aXcoordinate)
Sets the X coordinate on the page that this annotation object refers to.
Specified by:
setX in interface dkAnnotationExt
Parameters:
aXcoordinate - X coordinate

getX

public short getX()
Gets the X coordinate on the page that this annotation object refers to.
Specified by:
getX in interface dkAnnotationExt
Returns:
the X coordinate

setY

public void setY(short aYcoordinate)
Sets the Y coordinate on the page that this annotation object refers to.
Specified by:
setY in interface dkAnnotationExt
Parameters:
aYcoordinate - Y coordinate

getY

public short getY()
Gets the Y coordinate on the page that this annotation object refers to.
Specified by:
getY in interface dkAnnotationExt
Returns:
the Y coordinate

setPart

public void setPart(int aPartId)
Sets the part Id of the associated object, only positive values are valid.
Parameters:
aPartId - a part Id

getPart

public int getPart()
Gets the part Id of the associated object
Returns:
the part Id

equals

public boolean equals(DKAnnotationDL aDKAnnotationDL)
Compares this object with the parameter object.
Returns:
true if both objects have the same value for each data member; otherwise return false.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.