Package com.novomind.ecom.api.iagent.model

Interface ModifiableIssueNotes

All Superinterfaces:

IssueNotes

public interface ModifiableIssueNotes
extends IssueNotes

Represents a Collection of IssueNote associated with an Issue Allows to add new notes to the issue.

Since:

10.0.146

Method Summary

Modifier and Type	Method	Description
IssueNote	addNote(String text, User user)	The method creates and adds a note to an Issue If the text is invalid or too long to be stored persistently, a ValidationException will be thrown by the method.

Methods inherited from interface com.novomind.ecom.api.iagent.model.IssueNotes

getNotes, getNotes, getNotesCount

Method Details

addNote

IssueNote addNote(String text,
 User user)
           throws PersistencyException,
ValidationException

The method creates and adds a note to an Issue If the text is invalid or too long to be stored persistently, a ValidationException will be thrown by the method.

Parameters:

text - the text of the note as string

user - the author of the note

Returns:

the IssueNote that has been successfully added to the issue.

Throws:

PersistencyException - if the note could not be added to the issue.

ValidationException - if the text is invalid or to large to be added as note.

Since:

10.0.146