Package de.elo.ix.client

Class Note

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.Note
All Implemented Interfaces:
Serializable
public class Note extends ValueClass implements Serializable

This helper class inherits all members from NoteData and adds a static member to access the bit constants for the NoteData members.

See Also:

  • Field Details

    • TStamp

      protected String TStamp
      Timestamp of the last change to the note. The format is JJJJ.MM.DD.hh.mm.ss

    • XPos

      protected int XPos
      The position in the x axis when the note is displayed on a document in ELO. Taken from the top left corner of the document.

      For NoteC.TYPE_ANNOTATION_FREEHAND and NoteC.TYPE_ANNOTATION_HORIZONTAL_LINE the values XPos, YPos, Width, Height describe the enveloping rectangle of the line including the line width. This values are computed by the Indexserver if the note is stored.

    • YPos

      protected int YPos
      The position in the Y axis when the note is displayed on a document in ELO. Taken from the top left corner of the document.
      See Also:

    • desc

      protected String desc
      The text for the note.
      See Also:

    • guid

      protected String guid
      The GUID for the note.

    • height

      protected int height
      The height of the note (y axis), when displayed on a document in ELO.
      See Also:

    • id

      protected int id
      The unique id for the note.

    • ownerId

      protected int ownerId
      The ID of the user who created the note. Administrators can set the ownerId to an arbitary user ID in checkinNotes. Set ownerName="" in this case.

    • pageNo

      protected int pageNo
      The page number to which the note is attached.

    • type

      protected int type
      The note type.
      See Also:

    • width

      protected int width
      Width ( x axis) of the note when displayed on a document in ELO.
      See Also:

    • createDateIso

      protected String createDateIso
      ISO encoded external (user defined) date.

    • deleted

      protected boolean deleted
      True if the note is deleted, otherwise false.

    • lockId

      protected int lockId
      The ID of the user that holds the lock or -1, if the note is not locked.

    • lockName

      protected String lockName
      The user name that holds the lock or an empty string if the note is not locked.

    • objId

      protected String objId
      Object ID of the associated Sord object or any of the ID specifiers that are valid for checkoutSord too. Functions createNote and checkoutNotes return only numerical object IDs.

    • ownerName

      protected String ownerName
      The name of the user that has created the note. Administrators can set the ownerName to an arbitary user name in checkinNotes. Set ownerId=-1 in this case.

    • acl

      protected String acl
      Access control list. Only used for notes of type TYPE_ANNOTATION_MARKER. Set member aclItems=null on check in otherwise it is ignored.

    • aclItems

      protected AclItem[] aclItems
      Access control list as item array. Only used for notes of type TYPE_ANNOTATION_MARKER. If this member is not null, member acl is ignored on check in.

    • color

      protected int color
      RGB value. Undefined for notes of type TYPE_ANNOTATION_STAMP and TYPE_ANNOTATION_NOTE_WITHFONT.
      Since:
      6.00.087
      See Also:

    • noteText

      protected NoteText noteText
      Additional information for textual stamps. Valid only for notes of type TYPE_ANNOTATION_NOTE, TYPE_ANNOTATION_STAMP and TYPE_ANNOTATION_NOTE_WITHFONT. Either desc, noteText, noteImage or noteFreehand can be set.
      Since:
      7.00.000.023
      See Also:

    • noteImage

      protected NoteImage noteImage
      Additional information for image stamps. Valid only for notes of type TYPE_ANNOTATION_STAMP. Either desc, noteText, noteImage or noteFreehand can be set.
      Since:
      7.00.000.023
      See Also:

    • noteFreehand

      protected NoteFreehand noteFreehand
      Point information for a freehand line. Valid only for notes of type TYPE_ANNOTATION_FREEHAND and TYPE_ANNOTATION_HORIZONTAL_LINE. Either desc, noteText, noteImage or noteFreehand can be set.
      Since:
      7.00.000.023
      See Also:

    • access

      protected int access
      Access rights for the current user. Read-only.
      Since:
      7.00.000.026

    • deleteDateIso

      protected String deleteDateIso
      The Note is deleted at this date. ClientInfo determines the Timezone.

      Is undefined if isDeleted() returns false.

      Since:
      9.00.000.000

    • TStampSync

      protected String TStampSync
      Timestamp of this object's last export by the replication.
      Since:
      9.99.009.001

  • Constructor Details

    • Note

      public Note()

    • Note

      public Note(Note rhs)

  • Method Details

    • getTStamp

      public String getTStamp()

    • setTStamp

      public void setTStamp(String TStamp)

    • getXPos

      public int getXPos()

    • setXPos

      public void setXPos(int XPos)

    • getYPos

      public int getYPos()

    • setYPos

      public void setYPos(int YPos)

    • getDesc

      public String getDesc()

    • setDesc

      public void setDesc(String desc)

    • getGuid

      public String getGuid()

    • setGuid

      public void setGuid(String guid)

    • getHeight

      public int getHeight()

    • setHeight

      public void setHeight(int height)

    • getId

      public int getId()

    • setId

      public void setId(int id)

    • getOwnerId

      public int getOwnerId()

    • setOwnerId

      public void setOwnerId(int ownerId)

    • getPageNo

      public int getPageNo()

    • setPageNo

      public void setPageNo(int pageNo)

    • getType

      public int getType()

    • setType

      public void setType(int type)

    • getWidth

      public int getWidth()

    • setWidth

      public void setWidth(int width)

    • getCreateDateIso

      public String getCreateDateIso()

    • setCreateDateIso

      public void setCreateDateIso(String createDateIso)

    • isDeleted

      public boolean isDeleted()

    • setDeleted

      public void setDeleted(boolean deleted)

    • getLockId

      public int getLockId()

    • setLockId

      public void setLockId(int lockId)

    • getLockName

      public String getLockName()

    • setLockName

      public void setLockName(String lockName)

    • getObjId

      public String getObjId()

    • setObjId

      public void setObjId(String objId)

    • getOwnerName

      public String getOwnerName()

    • setOwnerName

      public void setOwnerName(String ownerName)

    • getAclItems

      public AclItem[] getAclItems()

    • setAclItems

      public void setAclItems(AclItem[] aclItems)

    • getAcl

      public String getAcl()

    • setAcl

      public void setAcl(String acl)

    • getColor

      public int getColor()

    • setColor

      public void setColor(int color)

    • getNoteText

      public NoteText getNoteText()

    • setNoteText

      public void setNoteText(NoteText textInfo)

    • getNoteImage

      public NoteImage getNoteImage()

    • setNoteImage

      public void setNoteImage(NoteImage imageInfo)

    • getNoteFreehand

      public NoteFreehand getNoteFreehand()

    • setNoteFreehand

      public void setNoteFreehand(NoteFreehand freehandInfo)

    • getAccess

      public int getAccess()

    • setAccess

      public void setAccess(int access)

    • getDeleteDateIso

      public String getDeleteDateIso()

    • setDeleteDateIso

      public void setDeleteDateIso(String deleteDateIso)

    • getTStampSync

      public String getTStampSync()

    • setTStampSync

      public void setTStampSync(String TStampSync)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      @Deprecated public boolean equals(Object obj)
      Deprecated.
      Overrides:
      equals in class Object

    • hashCode

      @Deprecated public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object