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

All Known Subinterfaces:

PrintDocumentAnnotations

public interface NoteCapable

Method Summary

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

Method Detail

addNote

void addNote(Note note)

Adds the Note.

Parameters:

highlight -

Throws:

org.eclipse.stardust.common.error.InvalidArgumentException - if the id of the Note already exists.

getNote

Note getNote(java.lang.String id)

getNotes

java.util.Set<Note> getNotes()

removeNote

void removeNote(java.lang.String id)

setNotes

void setNotes(java.util.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(java.util.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.