Package ch.ivyteam.ivy.workflow.note

Interface Notes

public interface Notes

Notes are suitable for adding user notes to a case or task.

Since:

12.0.0

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
NoteBuilder	add()	Add a new note.
List<Note>	all()	Returns all notes.
void	remove(Note note)	Remove the note

Method Details

all

List<Note> all()

Returns all notes.

Returns:

notes

API:

This public API is available in Java.

Security:

CaseNotes: SESSION OWNS NoteReadAll PERMISSION OR OWNS NoteReadAll@SYSTEM PERMISSION
TaskNotes: SESSION OWNS NoteReadAll PERMISSION OR OWNS NoteReadAll@SYSTEM PERMISSION

add

NoteBuilder add()

Add a new note. Note: The associated object (e.g. Case or Task) will be persisted.

Returns:

note builder

API:

This public API is available in Java.

Security:

CaseNotes: SESSION OWNS NoteCreate PERMISSION OR OWNS NoteCreate@SYSTEM PERMISSION
TaskNotes: SESSION OWNS NoteCreate PERMISSION OR OWNS NoteCreate@SYSTEM PERMISSION

remove

void remove(Note note)

Remove the note

Parameters:

note - note

API:

This public API is available in Java.

Security:

CaseNotes: SESSION OWNS NoteDelete PERMISSION OR OWNS NoteDelete@SYSTEM PERMISSION
TaskNotes: SESSION OWNS NoteDelete PERMISSION OR OWNS NoteDelete@SYSTEM PERMISSION