com.atlassian.jira.issue.comments
Interface CommentManager

All Known Implementing Classes:
DefaultCommentManager

public interface CommentManager

The CommentManager is used to retrieve and create comments in JIRA. Comments are always associated with an issue.


Field Summary
static java.lang.String EVENT_ORIGINAL_COMMENT_PARAMETER
           
 
Method Summary
 Comment convertToComment(org.ofbiz.core.entity.GenericValue commentGV)
          This is a convenience method that can be used to convert a GenericValue representation of a comment to a comment object.
 Comment create(Issue issue, java.lang.String author, java.lang.String body, boolean dispatchEvent)
          Creates a comment and associates it with the given issue.
 Comment create(Issue issue, java.lang.String author, java.lang.String body, java.lang.String groupLevel, java.lang.Long roleLevelId, boolean dispatchEvent)
          Creates a comment and associates it with the given issue.
 Comment create(Issue issue, java.lang.String author, java.lang.String body, java.lang.String groupLevel, java.lang.Long roleLevelId, java.util.Date created, boolean dispatchEvent)
          Creates a comment and associates it with the given issue.
 Comment create(Issue issue, java.lang.String author, java.lang.String updateAuthor, java.lang.String body, java.lang.String groupLevel, java.lang.Long roleLevelId, java.util.Date created, java.util.Date updated, boolean dispatchEvent)
          Creates a comment and associates it with the given issue.
 Comment create(Issue issue, java.lang.String author, java.lang.String updateAuthor, java.lang.String body, java.lang.String groupLevel, java.lang.Long roleLevelId, java.util.Date created, java.util.Date updated, boolean dispatchEvent, boolean tweakIssueUpdateDate)
          Creates a comment and associates it with the given issue.
 ChangeItemBean delete(Comment comment)
          Deletes the specified comment.
 Comment getCommentById(java.lang.Long commentId)
          Will return a comment for the passed in commentId.
 java.util.List<Comment> getComments(Issue issue)
          This will return all comments for a given issue.
 java.util.List<Comment> getCommentsForUser(Issue issue, com.opensymphony.user.User user)
          Retrieves all Comments on the given Issue that the given User has permission to see.
 long getCountForCommentsRestrictedByGroup(java.lang.String groupName)
          Returns the count of all Comment's that have their visibility restricted by the named group.
 MutableComment getMutableComment(java.lang.Long commentId)
          Retrieves comment by given id and returns it as mutable object.
 ProjectRole getProjectRole(java.lang.Long projectRoleId)
          This is a convenience method to allow us to easily get a ProjectRole.
 boolean isUserCommentAuthor(com.opensymphony.user.User user, Comment comment)
          Returns true if the given user is the author of the given comment.
 int swapCommentGroupRestriction(java.lang.String groupName, java.lang.String swapGroup)
          Updates Comment's such that comments that have a visibility restriction of the provided groupName will be changed to have a visibility restriction of the provided swapGroup.
 void update(Comment comment, boolean dispatchEvent)
          Persists the updated comment.
 

Field Detail

EVENT_ORIGINAL_COMMENT_PARAMETER

static final java.lang.String EVENT_ORIGINAL_COMMENT_PARAMETER
See Also:
Constant Field Values
Method Detail

getCommentsForUser

java.util.List<Comment> getCommentsForUser(Issue issue,
                                           com.opensymphony.user.User user)
Retrieves all Comments on the given Issue that the given User has permission to see. If the passed in user is null, only comments with no permission level set will be returned.

NOTE: keep in mind null user represents an anonymous i.e. non-logged in user.

Parameters:
issue - the comments are associated with.
user - the user whose permission level will be used to limit the comments returned.
Returns:
Possibly empty List of Comments

getComments

java.util.List<Comment> getComments(Issue issue)
This will return all comments for a given issue. Please note that this method does not perform any permission checks on the returned comments. If you are returning comments to the UI or service for a given User please use getCommentsForUser(Issueissue,Useruser)

Parameters:
issue - the comments are associated with.
Returns:
a List of comments, will return an empty list if none found.

create

Comment create(Issue issue,
               java.lang.String author,
               java.lang.String body,
               boolean dispatchEvent)
Creates a comment and associates it with the given issue. Using this method the comment will be created with a createdDate of the current date/time and with no visibility restrictions.

Parameters:
issue - the issue to associate the comment with.
author - the user who has created this comment.
body - the text of the comment.
dispatchEvent - if true then an event of type EventType.ISSUE_COMMENTED_ID will be dispatched and any notifications listening for that event will be triggered. If false no event will be dispatched.
Returns:
the object representation of the newly created comment.

create

Comment create(Issue issue,
               java.lang.String author,
               java.lang.String body,
               java.lang.String groupLevel,
               java.lang.Long roleLevelId,
               boolean dispatchEvent)
Creates a comment and associates it with the given issue. Using this method the comment will be created with a createdDate of the current time. If you have provided a groupLevel then the comment visibility will be restricted to the provided group, it is assumed that validation to insure that the group actually exists has been performed outside of this method. If you have provided a roleLevelId then the comment visibility will be restricted to the provided role, it is assumed that validation to insure that the role actually exists has been performed outside of this method.

NOTE: A comment should not have both a group level and role level visibility restriction. This method will not stop this, but it does not semantically make sense.

Parameters:
issue - the issue to associate the comment with.
author - the user who has created this comment.
body - the text of the comment.
groupLevel - is the group name to limit comment visibility to, this must be a valid group name.
roleLevelId - is the id of the the ProjectRole to limit comment visibility to, this must reference a valid project role.
dispatchEvent - if true then an event of type EventType.ISSUE_COMMENTED_ID will be dispatched and any notifications listening for that event will be triggered. If false no event will be dispatched.
Returns:
the object representation of the newly created comment.

create

Comment create(Issue issue,
               java.lang.String author,
               java.lang.String body,
               java.lang.String groupLevel,
               java.lang.Long roleLevelId,
               java.util.Date created,
               boolean dispatchEvent)
Creates a comment and associates it with the given issue. Using this method the comment will be created with a createdDate of the specified date. This method should be used if you are trying to preserve existing information and it is important to retain the original created date. If you have provided a groupLevel then the comment visibility will be restricted to the provided group, it is assumed that validation to insure that the group actually exists has been performed outside of this method. If you have provided a roleLevelId then the comment visibility will be restricted to the provided role, it is assumed that validation to insure that the role actually exists has been performed outside of this method.

NOTE: A comment should not have both a group level and role level visibility restriction. This method will not stop this, but it does not semantically make sense.

Parameters:
issue - the issue to associate the comment with.
author - the user who has created this comment.
body - the text of the comment.
groupLevel - is the group name to limit comment visibility to, this must be a valid group name.
roleLevelId - is the id of the the ProjectRole to limit comment visibility to, this must reference a valid project role.
created - is the date that will be used as the comments creation date.
dispatchEvent - if true then an event of type EventType.ISSUE_COMMENTED_ID will be dispatched and any notifications listening for that event will be triggered. If false no event will be dispatched.
Returns:
the object representation of the newly created comment.

create

Comment create(Issue issue,
               java.lang.String author,
               java.lang.String updateAuthor,
               java.lang.String body,
               java.lang.String groupLevel,
               java.lang.Long roleLevelId,
               java.util.Date created,
               java.util.Date updated,
               boolean dispatchEvent)
Creates a comment and associates it with the given issue. Using this method the comment will be created with a createdDate of the specified date. This method should be used if you are trying to preserve existing information and it is important to retain the original created date. If you have provided a groupLevel then the comment visibility will be restricted to the provided group, it is assumed that validation to insure that the group actually exists has been performed outside of this method. If you have provided a roleLevelId then the comment visibility will be restricted to the provided role, it is assumed that validation to insure that the role actually exists has been performed outside of this method.

NOTE: A comment should not have both a group level and role level visibility restriction. This method will not stop this, but it does not semantically make sense.

Parameters:
issue - the issue to associate the comment with.
author - the user who has created this comment.
updateAuthor - the user who has updated this comment last
body - the text of the comment.
groupLevel - is the group name to limit comment visibility to, this must be a valid group name.
roleLevelId - is the id of the the ProjectRole to limit comment visibility to, this must reference a valid project role.
created - is the date that will be used as the comments creation date.
updated - is the date that will be used as the comments updated date.
dispatchEvent - if true then an event of type EventType.ISSUE_COMMENTED_ID will be dispatched and any notifications listening for that event will be triggered. If false no event will be dispatched.
Returns:
the object representation of the newly created comment.

create

Comment create(Issue issue,
               java.lang.String author,
               java.lang.String updateAuthor,
               java.lang.String body,
               java.lang.String groupLevel,
               java.lang.Long roleLevelId,
               java.util.Date created,
               java.util.Date updated,
               boolean dispatchEvent,
               boolean tweakIssueUpdateDate)
Creates a comment and associates it with the given issue. Using this method the comment will be created with a createdDate of the specified date. This method should be used if you are trying to preserve existing information and it is important to retain the original created date. If you have provided a groupLevel then the comment visibility will be restricted to the provided group, it is assumed that validation to insure that the group actually exists has been performed outside of this method. If you have provided a roleLevelId then the comment visibility will be restricted to the provided role, it is assumed that validation to insure that the role actually exists has been performed outside of this method.

NOTE: A comment should not have both a group level and role level visibility restriction. This method will not stop this, but it does not semantically make sense.

Parameters:
issue - the issue to associate the comment with.
author - the user who has created this comment.
updateAuthor - the user who has updated this comment last
body - the text of the comment.
groupLevel - is the group name to limit comment visibility to, this must be a valid group name.
roleLevelId - is the id of the the ProjectRole to limit comment visibility to, this must reference a valid project role.
created - is the date that will be used as the comments creation date.
updated - is the date that will be used as the comments updated date.
dispatchEvent - if true then an event of type EventType.ISSUE_COMMENTED_ID will be dispatched and any notifications listening for that event will be triggered. If false no event will be dispatched.
tweakIssueUpdateDate - if true the issues 'updated' date will be set to now.
Returns:
the object representation of the newly created comment.

getProjectRole

ProjectRole getProjectRole(java.lang.Long projectRoleId)
This is a convenience method to allow us to easily get a ProjectRole. This is being used by the CommentImpl to get a ProjectRole.

NOTE: If you are trying to retrieve a ProjectRole then you should be using the ProjectRoleManager.

Parameters:
projectRoleId - the id to the ProjectRole object you would like returned.
Returns:
will return a ProjectRole based on the passed in projectRoleId.

convertToComment

Comment convertToComment(org.ofbiz.core.entity.GenericValue commentGV)
This is a convenience method that can be used to convert a GenericValue representation of a comment to a comment object.

Parameters:
commentGV - is the GenericValue representation of a comment.
Returns:
Comment object.

getCommentById

Comment getCommentById(java.lang.Long commentId)
Will return a comment for the passed in commentId.

Parameters:
commentId - the id representing the Comment you would like to retrieve.
Returns:
a Comment or null (if the user cannot browse the comment).
Throws:
java.lang.IllegalArgumentException - if its id is null

getMutableComment

MutableComment getMutableComment(java.lang.Long commentId)
Retrieves comment by given id and returns it as mutable object.

Parameters:
commentId - comment id
Returns:
mutable comment or null if comment with given id not found
Throws:
java.lang.IllegalArgumentException - if its id is null

update

void update(Comment comment,
            boolean dispatchEvent)
Persists the updated comment.

Parameters:
comment - to update
dispatchEvent - if true then an event of type EventType.ISSUE_COMMENT_EDITED_ID will be dispatched and any notifications listening for that event will be triggered. If false no event will be dispatched.
Throws:
java.lang.IllegalArgumentException - if comment passed in is null or its id is null

swapCommentGroupRestriction

int swapCommentGroupRestriction(java.lang.String groupName,
                                java.lang.String swapGroup)
Updates Comment's such that comments that have a visibility restriction of the provided groupName will be changed to have a visibility restriction of the provided swapGroup. Note: There is no validation performed by this method to determine if the provided swapGroup is a valid group with JIRA. This validation must be done by the caller.

Parameters:
groupName - identifies the group the comments are restricted by, this must not be null.
swapGroup - identifies the group the comments will be changed to be restricted by, this must not be null.
Returns:
tbe number of comments affected by the update.
Since:
v3.12

getCountForCommentsRestrictedByGroup

long getCountForCommentsRestrictedByGroup(java.lang.String groupName)
Returns the count of all Comment's that have their visibility restricted by the named group.

Parameters:
groupName - identifies the group the comments are restricted by, this must not be null.
Returns:
a count of Comment's who's visibility are restricted by the passed in group name.
Since:
v3.12

delete

ChangeItemBean delete(Comment comment)
Deletes the specified comment.

Parameters:
comment - to delete
Returns:
a change item that represents the change of deleting the comment
Throws:
java.lang.IllegalArgumentException - if comment passed in is null or its id is null

isUserCommentAuthor

boolean isUserCommentAuthor(com.opensymphony.user.User user,
                            Comment comment)
Returns true if the given user is the author of the given comment.

If the given Comment has a null author, this represents that it was created anonymously, and no-one is the author (returns false). If the given User is null, then this represents that the current user is anonymous, and the method will always return false.

Parameters:
user - The User. Can be null to represent current user is not logged in (anonymous).
comment - The Comment. Cannot be null.
Returns:
true if the given user is the author of the given comment.
Since:
v4.0


Copyright © 2002-2010 Atlassian. All Rights Reserved.