com.ibm.edms.od

Class ODNote

java.lang.Object

com.ibm.edms.od.ODNote

All Implemented Interfaces:

java.io.Serializable

public class ODNote
extends java.lang.Object
implements java.io.Serializable

A class representing an OnDemand note.
For example:

    ODNote note = new ODNote();
 

(c) Copyright IBM Corp. 1993, 2015. All Rights Reserved

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRIVATE_GROUP
static int	PRIVATE_USER
static int	PUBLIC

Constructor Summary

Constructors

Constructor and Description
ODNote() Default Class constructor.

Method Summary

Modifier and Type	Method and Description
char	getColor() Get the note color
java.lang.String	getDateTime() Get the note creation date/time.
java.lang.String	getGMTDateTime() Get the note creation date/time in GMT.
java.lang.String	getGroupName() Get the note group name.
double	getOffsetPercentX()
double	getOffsetPercentY()
int	getOffsetX() Get the offset of the note
int	getOffsetY()
int	getPageNum() Get the page number
java.lang.String	getText() Get the note text.
java.lang.String	getUserId() Get the note creator.
boolean	isDeleted() Determine if this note is deleted
boolean	isOkToCopy() Determine if this note can be copied to another server.
boolean	isPublic() Check if note is public or not.
void	setGroupName(java.lang.String groupName) Set the note group name.
void	setOkToCopy(boolean okToCopy) Set whether or not this note can be copied to another server.
void	setPageNumber(int pgNum) Set the page number of the annotation object for this ODNote for the JLDV applet
void	setPublic(boolean isPublic) Set whether or not this note is public.
void	setText(java.lang.String text) Set the note text.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PUBLIC

public static final int PUBLIC

See Also:

Constant Field Values

PRIVATE_USER

public static final int PRIVATE_USER

See Also:

Constant Field Values

PRIVATE_GROUP

public static final int PRIVATE_GROUP

See Also:

Constant Field Values

Constructor Detail

ODNote

public ODNote()

Default Class constructor.

Method Detail

isPublic

public boolean isPublic()

Check if note is public or not.

Returns:

true if note is specified as viewable by Public

setPublic

public void setPublic(boolean isPublic)

Set whether or not this note is public.

Parameters:

isPublic - true/false

isOkToCopy

public boolean isOkToCopy()

Determine if this note can be copied to another server.

Returns:

true/false

setOkToCopy

public void setOkToCopy(boolean okToCopy)

Set whether or not this note can be copied to another server.

Parameters:

okToCopy - true/false

isDeleted

public boolean isDeleted()

Determine if this note is deleted

Returns:

true/false

getPageNum

public int getPageNum()

Get the page number

Returns:

The page number the note is associated with.

getOffsetX

public int getOffsetX()

Get the offset of the note

Returns:

The X coordinate of the note placement.

getOffsetY

public int getOffsetY()

getOffsetPercentX

public double getOffsetPercentX()

getOffsetPercentY

public double getOffsetPercentY()

getColor

public char getColor()

Get the note color

Returns:

The color of the note.

See Also:

ODConstant.ColorWhite, ODConstant.ColorBlack, ODConstant.ColorRed, ODConstant.ColorBlue, ODConstant.ColorGreen, ODConstant.ColorYellow, ODConstant.ColorMagenta, ODConstant.ColorCyan, ODConstant.ColorGrey

getUserId

public java.lang.String getUserId()

Get the note creator.

Returns:

The userid of the individual who created the note.

getDateTime

public java.lang.String getDateTime()

Get the note creation date/time.

Returns:

Note creation timestamp.

getGMTDateTime

public java.lang.String getGMTDateTime()

Get the note creation date/time in GMT.

Returns:

Note creation timestamp.

getGroupName

public java.lang.String getGroupName()

Get the note group name.

Returns:

If the note was associated with an OnDemand group return this name.

setGroupName

public void setGroupName(java.lang.String groupName)

Set the note group name.

Parameters:

groupName - Set if note should be associated with an OnDemand group.

getText

public java.lang.String getText()

Get the note text.

Returns:

Note text.

setText

public void setText(java.lang.String text)

Set the note text.

Parameters:

text - The content of the note.

setPageNumber

public void setPageNumber(int pgNum)

Set the page number of the annotation object for this ODNote for the JLDV applet

Parameters:

pgNum - The page number where the annotation will appear