Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAnnotationOD

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

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

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

See Also:
Serialized Form

Field Summary
 java.lang.String _groupName
           
 boolean _isOkToCopy
           
 boolean _isPublic
           
 char _noteColor
           
 java.lang.String _text
           
 int _ulPageNumber
           
 short _usX
           
 short _usY
           
static int DK_OD_ANNOTATION_MAX_LEN
           
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantOD
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKAnnotationOD()
          Constructs a new DKAnnotationOD object.
DKAnnotationOD(boolean Public, boolean OkToCopy, int PageNumber, short Xcoordinate, short Ycoordinate, char noteColor, java.lang.String GroupName, java.lang.String Text)
          Constructs a new DKAnnotationOD object with input parameters.
DKAnnotationOD(DKAnnotationOD aDKAnnotationOD)
          Copy constructor.
 
Method Summary
 boolean equals(DKAnnotationOD aDKAnnotationOD)
          Compares this object with the parameter object.
 char getColor()
          Gets the note color.
 java.lang.String getGroupName()
          Gets the group name of the note.
 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
 java.lang.String getText()
          Gets the text of the note.
 java.lang.String getTimestamp()
          Gets the creation timestamp of this note.
 java.lang.String getUserID()
          Gets the userid associated with this note.
 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.
 boolean isOkToCopy()
          Checks to see if it is ok to copy this note to another server.
 boolean isPublic()
          Checks to see if this note is public readable.
 void setColor(char color)
          Sets the color for this note.
 void setName(java.lang.String extName)
          Sets the name of this extension object
 void setOkToCopy(boolean isOkToCopy)
          Sets this note permission so it is ok to copy it to another OnDemand server.
 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 setPublic(boolean isPublic)
          Sets this note to be a public note if true, private note otherwise.
 void setTimestamp(java.lang.String datetime)
          Sets the creation timestamp of this note.
 void setUserId(java.lang.String uid)
          Sets the userid associated with this note.
 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
 

Field Detail

DK_OD_ANNOTATION_MAX_LEN

public static final int DK_OD_ANNOTATION_MAX_LEN

_ulPageNumber

public int _ulPageNumber

_isPublic

public boolean _isPublic

_isOkToCopy

public boolean _isOkToCopy

_usX

public short _usX

_usY

public short _usY

_noteColor

public char _noteColor

_groupName

public java.lang.String _groupName

_text

public java.lang.String _text
Constructor Detail

DKAnnotationOD

public DKAnnotationOD()
Constructs a new DKAnnotationOD object.
Parameters:
none -  

DKAnnotationOD

public DKAnnotationOD(boolean Public,
                      boolean OkToCopy,
                      int PageNumber,
                      short Xcoordinate,
                      short Ycoordinate,
                      char noteColor,
                      java.lang.String GroupName,
                      java.lang.String Text)
Constructs a new DKAnnotationOD object with input parameters.
Parameters:
Public - is the new annotation a public note
OkToCopy - can the annotation be copied to another server
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
noteColor - the color the annotation should be painted
GroupName - group annotation is associated with
Text - annotation content

DKAnnotationOD

public DKAnnotationOD(DKAnnotationOD aDKAnnotationOD)
Copy constructor.
Parameters:
aDKAnnotationOD - the DKAnnotationOD object to be copied from
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

setPublic

public void setPublic(boolean isPublic)
Sets this note to be a public note if true, private note otherwise.
Parameters:
isPublic - a boolean value, false == not public

isPublic

public boolean isPublic()
Checks to see if this note is public readable.
Returns:
the public value

setOkToCopy

public void setOkToCopy(boolean isOkToCopy)
Sets this note permission so it is ok to copy it to another OnDemand server.
Parameters:
isOkToCopy - a boolean value, false == cannot be copied

isOkToCopy

public boolean isOkToCopy()
Checks to see if it is ok to copy this note to another server.
Returns:
the public value

setColor

public void setColor(char color)
Sets the color for this note.
Parameters:
noteColor -  

getColor

public char getColor()
Gets the note color.
Returns:
the note color

getUserID

public java.lang.String getUserID()
Gets the userid associated with this note.
Returns:
the creators userid.

setUserId

public void setUserId(java.lang.String uid)
Sets the userid associated with this note.

getTimestamp

public java.lang.String getTimestamp()
Gets the creation timestamp of this note.
Returns:
the creation date

setTimestamp

public void setTimestamp(java.lang.String datetime)
Sets the creation timestamp of this note.

getText

public java.lang.String getText()
Gets the text of the note.
Returns:
the note text

getGroupName

public java.lang.String getGroupName()
Gets the group name of the note.
Returns:
the note group

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(DKAnnotationOD aDKAnnotationOD)
Compares this object with the parameter object.
Parameters:
aDKAnnotationOD - the DKAnnotationOD object to be compared to
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.