Package ch.ivyteam.ivy.workflow
Interface INoteable
-
- All Known Subinterfaces:
IBusinessCase
,ICase
,ITask
public interface INoteable
All workflow classes that implement this interface are able to handle notes.- Since:
- 17.05.2006
- API:
- This is a public API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description INote
createNote(IWorkflowSession session, String message)
Creates a new note associated with this object.void
deleteNote(INote note)
Deletes the given noteList<INote>
getNotes()
Gets all notes associated with this objectboolean
hasNotes()
Returns true if the object has notes, otherwise false
-
-
-
Method Detail
-
createNote
INote createNote(IWorkflowSession session, String message) throws PersistencyException
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 notemessage
- the note itself- Returns:
- the created note
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- Case: SESSION OWNS NoteCreate PERMISSION OR OWNS NoteCreate@SYSTEM PERMISSION
Task: SESSION OWNS NoteCreate PERMISSION OR OWNS NoteCreate@SYSTEM PERMISSION
-
getNotes
List<INote> getNotes() throws PersistencyException
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 IvyScript and Java. It has the visibility ADVANCED.
- Security:
- Case: SESSION OWNS NoteReadAll PERMISSION OR OWNS NoteReadAll@SYSTEM PERMISSION
Task: SESSION OWNS NoteReadAll PERMISSION OR OWNS NoteReadAll@SYSTEM PERMISSION
-
hasNotes
boolean hasNotes() throws PersistencyException
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 IvyScript and Java. It has the visibility ADVANCED.
-
deleteNote
void deleteNote(INote note) throws PersistencyException
Deletes the given note- Parameters:
note
- the node to delete- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- Case: SESSION OWNS NoteDelete PERMISSION OR OWNS NoteDelete@SYSTEM PERMISSION
Task: SESSION OWNS NoteDelete PERMISSION OR OWNS NoteDelete@SYSTEM PERMISSION
-
-