Package ch.ivyteam.ivy.workflow

Interface INoteable

All Known Subinterfaces:

IBusinessCase, ICase, ITask

@Deprecated(since="12.0.0",
            forRemoval=true)
public interface INoteable

Deprecated, for removal: This API element is subject to removal in a future version.

use ICase.notes() or ITask.notes()

All workflow classes that implement this interface are able to handle notes.

Since:

17.05.2006

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
INote	createNote(IWorkflowSession session, String message)	Deprecated, for removal: This API element is subject to removal in a future version. use ICase.notes() or ITask.notes() followed by Notes.add()
void	deleteNote(INote note)	Deprecated, for removal: This API element is subject to removal in a future version. use ICase.notes() or ITask.notes() followed by Notes.remove(ch.ivyteam.ivy.workflow.note.Note)
List<INote>	getNotes()	Deprecated, for removal: This API element is subject to removal in a future version. use ICase.notes() or ITask.notes() followed by Notes.all()
boolean	hasNotes()	Deprecated, for removal: This API element is subject to removal in a future version. use ICase.notes() or ITask.notes() followed by Notes.all() and is not Collection.isEmpty()

Method Details

createNote

@Deprecated(since="12.0.0",
            forRemoval=true)
INote createNote(IWorkflowSession session,
 String message)

Deprecated, for removal: This API element is subject to removal in a future version.

use ICase.notes() or ITask.notes() followed by Notes.add()

Creates a new note associated with this object.

Note: If the object (task or case), on which the additional property is set, is not yet persisted in the system database then the object (task or case) will be persisted in the system database by this method.

Parameters:

session - the session which creates the note

message - the note itself

Returns:

the created note

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

getNotes

@Deprecated(since="12.0.0",
            forRemoval=true)
List<INote> getNotes()

Deprecated, for removal: This API element is subject to removal in a future version.

use ICase.notes() or ITask.notes() followed by Notes.all()

Gets all notes associated with this object

Returns:

iterator with the notes information

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

hasNotes

@Deprecated(since="12.0.0",
            forRemoval=true)
boolean hasNotes()

Deprecated, for removal: This API element is subject to removal in a future version.

use ICase.notes() or ITask.notes() followed by Notes.all() and is not Collection.isEmpty()

Returns true if the object has notes, otherwise false

Returns:

true if the object has notes, otherwise false

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.

deleteNote

@Deprecated(since="12.0.0",
            forRemoval=true)
void deleteNote(INote note)

Deprecated, for removal: This API element is subject to removal in a future version.

use ICase.notes() or ITask.notes() followed by Notes.remove(ch.ivyteam.ivy.workflow.note.Note)

Deletes the given note

Parameters:

note - the node to delete

Throws:

PersistencyException - if persistency access fails

API:

This public API is available in Java.