com.atlassian.bamboo.comment
Interface CommentManager

All Known Implementing Classes:

CommentManagerImpl

public interface CommentManager

Method Summary

Comment	addComment(java.lang.String content, ResultsSummary resultsSummary, com.atlassian.user.User user) Deprecated. since 5.0 use addComment(content, user, resultsSummary.getId)
Comment	addComment(java.lang.String content, com.atlassian.user.User user, long entityId)
void	deleteAllCommentsForEntity(BambooIdProvider entity)
void	deleteComment(Comment comment)
void	deleteComment(Comment comment, ResultsSummary resultsSummary) Deprecated. since 5.0 use deleteComment(comment)
Comment	getCommentById(long commentId)
java.util.List<Comment>	getCommentsByUserForPlans(java.lang.String userName, java.util.List<? extends Plan> plans) Returns the list of comments written by a specified user for the requested plans.
java.util.List<Comment>	getCommentsForEntity(long entityId)
java.util.List<Comment>	getPlanResultComments(ResultsSummary resultsSummary) Deprecated. since 4.4 use ImmutableResultsSummary.getComments() instead. Jobs no longer have comments
boolean	hasPlanResultComments(ResultsSummary resultsSummary) Deprecated. since 4.4 use ImmutableResultsSummary.getComments() instead. Jobs no longer have comments
void	saveComment(Comment comment) Saves or updates a comment to the database

Method Detail

addComment

Comment addComment(java.lang.String content,
                   ResultsSummary resultsSummary,
                   com.atlassian.user.User user)

Deprecated. since 5.0 use addComment(content, user, resultsSummary.getId)

deleteComment

void deleteComment(Comment comment,
                   ResultsSummary resultsSummary)

Deprecated. since 5.0 use deleteComment(comment)

addComment

Comment addComment(java.lang.String content,
                   com.atlassian.user.User user,
                   long entityId)

deleteComment

void deleteComment(Comment comment)

deleteAllCommentsForEntity

void deleteAllCommentsForEntity(@NotNull
                                BambooIdProvider entity)

getCommentsForEntity

@NotNull
java.util.List<Comment> getCommentsForEntity(long entityId)

getCommentById

Comment getCommentById(long commentId)

saveComment

void saveComment(Comment comment)

Saves or updates a comment to the database

Parameters:

comment - to save

hasPlanResultComments

@Deprecated
boolean hasPlanResultComments(@NotNull
                                         ResultsSummary resultsSummary)

Deprecated. since 4.4 use ImmutableResultsSummary.getComments() instead. Jobs no longer have comments

getPlanResultComments

@NotNull
@Deprecated
java.util.List<Comment> getPlanResultComments(@NotNull
                                                                 ResultsSummary resultsSummary)

Deprecated. since 4.4 use ImmutableResultsSummary.getComments() instead. Jobs no longer have comments

Returns the list of comments attached to a plan and its subplans sorted by date (newest first).

Parameters:

resultsSummary -

Returns:

getCommentsByUserForPlans

@NotNull
java.util.List<Comment> getCommentsByUserForPlans(@NotNull
                                                          java.lang.String userName,
                                                          @NotNull
                                                          java.util.List<? extends Plan> plans)

Returns the list of comments written by a specified user for the requested plans.

Parameters:

userName -

plans - non-empty list of plans

Returns:

the list of comments written by the specified user for the given plans.

Throws:

java.lang.IllegalArgumentException - if plans is empty