com.atlassian.jira.issue.comments

Interface CommentOrderManager

All Known Implementing Classes:

CommentOrderManagerImpl

public interface CommentOrderManager

The CommentOrderManager is used to store and read chosen comment sort order

Method Summary

Modifier and Type	Method and Description
TabPanelOrder	getIssueCommentsOrder() Get a comments order from user preferences
List<Comment>	getSortedComments(Issue issue, ApplicationUser user) Get all Comments on the given Issue that the given ApplicationUser has permission to see.
void	setIssueCommentsOrder(TabPanelOrder order) Set a comments order in user preferences

Method Detail

setIssueCommentsOrder

void setIssueCommentsOrder(TabPanelOrder order)
                    throws com.atlassian.core.AtlassianCoreException

Set a comments order in user preferences

Parameters:

order - value from TabPanelOrder enum

Throws:

com.atlassian.core.AtlassianCoreException - if user preferences is null

getIssueCommentsOrder

TabPanelOrder getIssueCommentsOrder()

Get a comments order from user preferences

Returns:

a value from TabPanelOrder enum which represents the saved order in user preferences

getSortedComments

List<Comment> getSortedComments(Issue issue,
                                ApplicationUser user)

Get all Comments on the given Issue that the given ApplicationUser has permission to see.

Parameters:

issue - the comments are associated with.

user - the user whose permission level will be used to limit the comments returned.

Returns:

a list of the Comments