Package com.atlassian.jira.user
Interface UserHistoryManager
- All Known Implementing Classes:
DefaultUserHistoryManager
,MockUserHistoryManager
public interface UserHistoryManager
The manager responsible for storing and retreiving
UserHistoryItem
objects.
Although it is possible to store a reference to any UserHistoryItem.Type
it has
special methods for Issue history as that is the only use internal to JIRA.- Since:
- v4.0
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addItemToHistory
(UserHistoryItem.Type type, ApplicationUser user, String entityId) Create and add anUserHistoryItem
to the Users history list.void
addItemToHistory
(UserHistoryItem.Type type, ApplicationUser user, String entityId, String data) Create and add anUserHistoryItem
to the Users history list.void
addUserToHistory
(UserHistoryItem.Type type, ApplicationUser user, ApplicationUser entity) Create and add anUserHistoryItem
to the Users history list.getHistory
(UserHistoryItem.Type type, ApplicationUser user) Retreive the user's history queue for the givenUserHistoryItem.Type
.boolean
hasHistory
(UserHistoryItem.Type type, ApplicationUser user) Determines whether a user has any items in their history for a givenUserHistoryItem.Type
This method performs no permission checks.void
Remove the user's history.
-
Method Details
-
addUserToHistory
Create and add anUserHistoryItem
to the Users history list. A null users history should still be stored, even if only for duration of session.- Parameters:
type
- The type queue to add the history item touser
- The user to add the history item toentity
- The entity to add to the history queue.
-
addItemToHistory
Create and add anUserHistoryItem
to the Users history list. A null users history should still be stored, even if only for duration of session.- Parameters:
type
- The type queue to add the history item touser
- The user to add the history item toentityId
- The entity id of the entity to add to the history queue.
-
addItemToHistory
void addItemToHistory(UserHistoryItem.Type type, ApplicationUser user, String entityId, String data) Create and add anUserHistoryItem
to the Users history list. Allows to store data related to the user history item.- Parameters:
type
- The type queue to add the history item touser
- The user to add the history item toentityId
- The entity id of the entity to add to the history queuedata
- Data related to the history item. Can be null.
-
hasHistory
Determines whether a user has any items in their history for a givenUserHistoryItem.Type
This method performs no permission checks.- Parameters:
type
- The type to check foruser
- The user to check for.- Returns:
- true if the user has any entities in their queue of the give type, false otherwise
-
getHistory
Retreive the user's history queue for the givenUserHistoryItem.Type
. The list is returned ordered by DESC lastViewed date (i.e. newest is first). This method performs no permission checks.- Parameters:
type
- The type of entity to get the history foruser
- The user to get the history items for.- Returns:
- a list of history items sort by desc lastViewed date.
-
removeHistoryForUser
Remove the user's history.- Parameters:
user
- The User to remove the history for.
-