Index

DKAnnotationOD

Purpose:

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

Heirarchy:     
 
      dkExtension
      dkAnnotationExt
      DKAnnotationOD

Class summary:

class DKEXPORT DKAnnotationOD: public dkAnnotationExt
{
  public:
   DKAnnotationOD();
    DKAnnotationOD(ULONG      partId,
                   DKBoolean  Public,
                   DKBoolean  OkToCopy,
                   long       PageNumber,
                   short      Xcoordinate,
                   short      Ycoordinate,
                   char       noteColor,
                   DKString   UserId,
                   DKString   DateTime,
                   DKString   GroupName,
                   ULONG      NoteNumber,
                   DKString   Text);
 
    DKAnnotationOD(DKAnnotationOD& aDKAnnotationOD);  
 
    ~DKAnnotationOD();
 
    void copyData(DKAnnotationOD& aDKAnnotationOD);
 
    void  setPublic(DKBoolean isPublic);
    DKBoolean isPublic();
 
    void  setOkToCopy(DKBoolean isOkToCopy);
    DKBoolean isOkToCopy();
 
    void setColor(char color);
    char getColor();
 
    void     setUserId(DKString uid);
    DKString getUserID();
 
    void     setTimestamp(DKString datetime);
    DKString getTimestamp();
 
    DKString getText();
    DKString getGroupName();
    ULONG    getNoteNumber();
 
    void   setPart(ULONG aPartId);
    ULONG  getPart();
 
    static void  setNumNotes(ULONG NumNotes);
    static ULONG getNumNotes();
 
    DKAnnotationOD&  operator=(const DKAnnotationOD& aAnnot);
    DKBoolean operator==(const DKAnnotationOD& aAnnot) const;
 
};

Members:

Constructors and destructor
To create the annotation object in one step, the constructor can also take the input parameters.
   DKAnnotationOD();
   DKAnnotationOD(ULONG      partId,
                  DKBoolean  Public,
                  DKBoolean  OkToCopy,
                  long       PageNumber,
                  short      Xcoordinate,
                  short      Ycoordinate,
                  char       noteColor,
                  DKString   UserId,
                  DKString   DateTime,
                  DKString   GroupName,
                  ULONG      NoteNumber,
                  DKString   Text);
 
   DKAnnotationOD(const DKAnnotationOD& aAnnot);
   virtual ~DKAnnotationOD();
 

Member functions

operator=
Assignment operator.
   DKAnnotation&  operator=(const DKAnnotation& aAnnot);

operator==
Compares this operator with the specified object. Returns true if both objects have the same value for each data member.
   DKBoolean operator==(const DKAnnotationOD& aAnnot) const;

setPart
Sets the part number of the affiliated object. Only positive values are valid.
   void  setPart(unsigned long aPartNumber);

getPart
Gets the part number of the affiliated object.
   unsigned long getPart();

copyData
Copy data member values from the source aDKAnnotationOD object.
   void copyData(DKAnnotationOD& aDKAnnotationOD);

setPublic
Sets this note to be a public note if TRUE, private note otherwise.

   void  setPublic(DKBoolean isPublic);

isPublic
Checks to see if this note is public readable.
   DKBoolean isPublic();

setOkToCopy
Sets this note permission so it is ok to copy it to another OnDemand server.
   void  setOkToCopy(DKBoolean isOkToCopy);

isOkToCopy
Checks to see if it is ok to copy this note to another server.
   DKBoolean isOkToCopy();

setColor
Sets the color for this note.
   void setColor(char color);

getColor
Gets the note color.
   char getColor();

setUserId
Sets the userid associated with this note.
   void setUserId(DKString uid);

getUserID
Gets the userid associated with this note.
   DKString getUserID();

setTimestamp
Sets the creation timestamp of this note.
   void setTimestamp(DKString datetime);

getUserID
Gets the userid associated with this note.
   DKString getUserID();

setTimestamp
Sets the creation timestamp of this note.
   void setTimestamp(DKString datetime);

getTimestamp
Gets the creation timestamp of this note.
   DKString getTimestamp();

getText
Gets the text of the note.
   DKString getText();

getGroupName
Gets the group name of the note.
   DKString getGroupName();

getNoteNumber
Gets the note number name of the note.
   ULONG getNoteNumber();

setNumNotes
This static function sets the total number of notes for the associated class.
   static void setNumNotes(ULONG NumNotes);

getNumNotes
This static function gets the total number of notes associated with this class
   static ULONG getNumNotes();

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