org.eclipse.stardust.engine.extensions.dms.data.annotations.printdocument
Interface NoteCapable

All Known Subinterfaces:
PrintDocumentAnnotations

public interface NoteCapable


Method Summary
 void addAllNotes(Set<Note> notes)
          Adds the given set of notes to the stored ones.
 void addNote(Note note)
          Adds the Note.
 Note getNote(String id)
           
 Set<Note> getNotes()
           
 void removeAllNotes()
          Removes all notes.
 void removeNote(String id)
           
 void setNotes(Set<Note> notes)
          Replaces the stored notes with the given set.
 

Method Detail

addNote

void addNote(Note note)
Adds the Note.

Parameters:
note -
Throws:
org.eclipse.stardust.common.error.InvalidArgumentException - if the id of the Note already exists.

getNote

Note getNote(String id)

getNotes

Set<Note> getNotes()

removeNote

void removeNote(String id)

setNotes

void setNotes(Set<Note> notes)
Replaces the stored notes with the given set.

Parameters:
notes -
Throws:
org.eclipse.stardust.common.error.InvalidArgumentException - if the given set contains more than one element with the same Identifiable#id.

addAllNotes

void addAllNotes(Set<Note> notes)
Adds the given set of notes to the stored ones.

Parameters:
notes -
Throws:
org.eclipse.stardust.common.error.InvalidArgumentException - if the given set contains more than one element with the same Identifiable#id.
org.eclipse.stardust.common.error.InvalidArgumentException - if the given set contains at least one note with the same Identifiable#id as a stored note.

removeAllNotes

void removeAllNotes()
Removes all notes.



Copyright © 2017 Eclipse Stardust. All Rights Reserved.