Package com.atlassian.jira.user
Interface UserIssueHistoryManager
- All Known Implementing Classes:
DefaultUserIssueHistoryManager
public interface UserIssueHistoryManager
A wrapper of the
UserHistoryManager
that allows you to deal directly with Issue objects- Since:
- v4.0
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addIssueToHistory
(ApplicationUser user, Issue issue) Add anIssue
to the user history list.Retrieve the user's issue history queue.Retrieve the user's issue history queue.Retrieve the first X (jira.max.issue.history.dropdown.items) Issues from the user's issue history queue.boolean
Determines whether the user has a current issue history.
-
Field Details
-
DEFAULT_ISSUE_HISTORY_DROPDOWN_ITEMS
static final int DEFAULT_ISSUE_HISTORY_DROPDOWN_ITEMS- See Also:
-
-
Method Details
-
addIssueToHistory
Add anIssue
to the user history list. A null users history should still be stored, even if only for duration of session- Parameters:
user
- The user to add the history item toissue
- The issue to add to the history list
-
hasIssueHistory
Determines whether the user has a current issue history. This method also performs permission checks against issue to ensure that user can see at least 1 issue.- Parameters:
user
- The user to check for.- Returns:
- true if the user has at least 1 issue in their issue history queue that they can see, false otherwise
-
getFullIssueHistoryWithoutPermissionChecks
Retrieve the user's issue history queue. The list is returned ordered by DESC lastViewed date (i.e. newest is first). This method performs no permission checks.- Parameters:
user
- The user to get the history issue items for.- Returns:
- a list of history issue items sort by desc lastViewed date.
-
getFullIssueHistoryWithPermissionChecks
Retrieve the user's issue history queue. The list is returned ordered by DESC lastViewed date (i.e. newest is first). This method performs permission checks.- Parameters:
user
- The user to get the history issue items for.- Returns:
- a list of history issue items sort by desc lastViewed date.
-
getShortIssueHistory
Retrieve the first X (jira.max.issue.history.dropdown.items) Issues from the user's issue history queue. This purpose of this method is to return a small list for easy display. The filtering could be done in the view code, but for performance reasons, is done here. The list is returned ordered by DESC lastViewed date (i.e. newest is first). This method performs permission checks.- Parameters:
user
- The user to get the history issue items for.- Returns:
- a list of issue items sorted by desc lastViewed date.
-