|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKAnnotationOD
This class is a wrapper of OD CsvNote. The data structure provides information about an annotation affiliated with an object.
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 |
public static final int DK_OD_ANNOTATION_MAX_LEN
public int _ulPageNumber
public boolean _isPublic
public boolean _isOkToCopy
public short _usX
public short _usY
public char _noteColor
public java.lang.String _groupName
public java.lang.String _text
Constructor Detail |
public DKAnnotationOD()
none
- public DKAnnotationOD(boolean Public, boolean OkToCopy, int PageNumber, short Xcoordinate, short Ycoordinate, char noteColor, java.lang.String GroupName, java.lang.String Text)
Public
- is the new annotation a public noteOkToCopy
- can the annotation be copied to another serverpageNumber
- the page number that this annotation object refers toXcoordinate
- the X coordinate on the page that this annotation object refers toYcoordinate
- the Y coordinate on the page that this annotation object refers tonoteColor
- the color the annotation should be paintedGroupName
- group annotation is associated withText
- annotation contentpublic DKAnnotationOD(DKAnnotationOD aDKAnnotationOD)
aDKAnnotationOD
- the DKAnnotationOD object to be copied fromMethod Detail |
public java.lang.String getName() throws java.lang.Exception
getName
in interface dkExtension
public void setName(java.lang.String extName) throws java.lang.Exception
setName
in interface dkExtension
extName
- name of this extension objectpublic void setPageNumber(int aPageNumber)
setPageNumber
in interface dkAnnotationExt
aPageNumber
- a page numberpublic int getPageNumber()
getPageNumber
in interface dkAnnotationExt
public void setX(short aXcoordinate)
setX
in interface dkAnnotationExt
aXcoordinate
- X coordinatepublic short getX()
getX
in interface dkAnnotationExt
public void setY(short aYcoordinate)
setY
in interface dkAnnotationExt
aYcoordinate
- Y coordinatepublic short getY()
getY
in interface dkAnnotationExt
public void setPublic(boolean isPublic)
isPublic
- a boolean value, false == not publicpublic boolean isPublic()
public void setOkToCopy(boolean isOkToCopy)
isOkToCopy
- a boolean value, false == cannot be copiedpublic boolean isOkToCopy()
public void setColor(char color)
noteColor
- public char getColor()
public java.lang.String getUserID()
public void setUserId(java.lang.String uid)
public java.lang.String getTimestamp()
public void setTimestamp(java.lang.String datetime)
public java.lang.String getText()
public java.lang.String getGroupName()
public void setPart(int aPartId)
aPartId
- a part Idpublic int getPart()
public boolean equals(DKAnnotationOD aDKAnnotationOD)
aDKAnnotationOD
- the DKAnnotationOD object to be compared to
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |