|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
void |
addItemToHistory(UserHistoryItem.Type type,
com.atlassian.crowd.embedded.api.User user,
String entityId)
Create and add an UserHistoryItem to the Users history list. |
void |
addItemToHistory(UserHistoryItem.Type type,
com.atlassian.crowd.embedded.api.User user,
String entityId,
String data)
|
List<UserHistoryItem> |
getHistory(UserHistoryItem.Type type,
com.atlassian.crowd.embedded.api.User user)
Retreive the user's history queue for the given UserHistoryItem.Type . |
boolean |
hasHistory(UserHistoryItem.Type type,
com.atlassian.crowd.embedded.api.User user)
Determines whether a user has any items in their history for a given UserHistoryItem.Type
This method performs no permission checks. |
void |
removeHistoryForUser(com.atlassian.crowd.embedded.api.User user)
Remove the user's history. |
Method Detail |
---|
void addItemToHistory(UserHistoryItem.Type type, com.atlassian.crowd.embedded.api.User user, String entityId)
UserHistoryItem
to the Users history list.
A null users history should still be stored, even if only for duration of session.
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.void addItemToHistory(UserHistoryItem.Type type, com.atlassian.crowd.embedded.api.User user, String entityId, String data)
boolean hasHistory(UserHistoryItem.Type type, com.atlassian.crowd.embedded.api.User user)
UserHistoryItem.Type
This method performs no permission checks.
type
- The type to check foruser
- The user to check for.
@NotNull List<UserHistoryItem> getHistory(UserHistoryItem.Type type, com.atlassian.crowd.embedded.api.User user)
UserHistoryItem.Type
.
The list is returned ordered by DESC lastViewed date (i.e. newest is first).
This method performs no permission checks.
type
- The type of entity to get the history foruser
- The user to get the history items for.
void removeHistoryForUser(@NotNull com.atlassian.crowd.embedded.api.User user)
user
- The User to remove the history for.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |