@PublicApi
public interface ChangeHistoryManager
Modifier and Type | Method and Description |
---|---|
Collection<Issue> |
findUserHistory(ApplicationUser remoteUser,
Collection<String> userkeys,
Collection<Project> projects,
int maxResults)
Find a list of issues that the given users have acted on with the option to limit the projects included
in the search.
|
Collection<Issue> |
findUserHistory(ApplicationUser remoteUser,
Collection<String> userkeys,
Collection<Project> projects,
int maxResults,
Date oldestUpdateTime)
Find a list of issues that the given users have acted on with the option to limit the projects included
in the search.
|
Collection<Issue> |
findUserHistory(ApplicationUser remoteUser,
Collection<String> userkeys,
int maxResults)
Find a list of issues that the given users have acted on.
|
List<ChangeHistoryItem> |
getAllChangeItems(Issue issue)
Returns a List of
ChangeHistoryItem 's for the given issue. |
List<ChangeHistory> |
getChangeHistories(Issue issue)
Returns a List of ChangeHistory entities
|
List<ChangeHistory> |
getChangeHistoriesForUser(Issue issue,
ApplicationUser remoteUser)
Returns a List of ChangeHistory entities for a single issue.
|
List<ChangeHistory> |
getChangeHistoriesForUser(Iterable<Issue> issues,
ApplicationUser remoteUser)
Returns a List of ChangeHistory entities for multiple issues.
|
List<ChangeHistory> |
getChangeHistoriesForUser(Iterable<Issue> issues,
ApplicationUser remoteUser,
Integer limit)
Returns a List of ChangeHistory entities for multiple issues.
|
List<ChangeHistory> |
getChangeHistoriesSince(Issue issue,
Date since)
Returns a List of ChangeHistory entities that occurred after the provided date.
|
ChangeHistory |
getChangeHistoryById(Long changeGroupId) |
List<ChangeItemBean> |
getChangeItemsForField(Issue issue,
String changeItemFieldName)
Returns a list of ChangeItemBean for the given issue which also are for the provided changeItemFieldName (i.e.
|
List<ChangeItemBean> |
getChangeItemsForField(Issue issue,
String changeItemFieldName,
Date since)
Returns a list of ChangeItemBean for the given issue which also are for the provided changeItemFieldName (i.e.
|
List<ChangeHistory> |
getChangeItemsWithFieldsForIssues(Iterable<Issue> issues,
Iterable<String> fieldNames)
Returns a List of ChangeHistory for the listed issues with changes only for the listed fields.
|
void |
removeAllChangeItems(Issue issue)
Remove all change items associated with an issue.
|
List<ChangeHistory> getChangeHistories(Issue issue)
issue
- the issue.@Nonnull List<ChangeHistory> getChangeHistoriesSince(@Nonnull Issue issue, @Nonnull Date since)
issue
- the issue. Must not be null.since
- only change histories made after this date will be returned. Must not be null.List<ChangeHistory> getChangeHistoriesForUser(Issue issue, ApplicationUser remoteUser)
issue
- the issue.remoteUser
- the user who is asking.for a more
efficient way to read change histories for multiple issues
List<ChangeHistory> getChangeHistoriesForUser(Iterable<Issue> issues, ApplicationUser remoteUser)
#getChangeHistoriesForUser(com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User)
and should be
preferred whenever possible.issues
- the issues.remoteUser
- the user who is asking.List<ChangeHistory> getChangeHistoriesForUser(Iterable<Issue> issues, ApplicationUser remoteUser, Integer limit)
#getChangeHistoriesForUser(com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User)
and should be
preferred whenever possible. Returnsissues
- the issues.remoteUser
- the user who is asking.limit
- maximum amount of records to returnList<ChangeItemBean> getChangeItemsForField(Issue issue, String changeItemFieldName)
issue
- the issue the change items are associated with, not null.changeItemFieldName
- the field name the change item is stored under, not null or empty.@Nonnull @ExperimentalApi List<ChangeItemBean> getChangeItemsForField(@Nonnull Issue issue, String changeItemFieldName, @Nonnull Date since)
issue
- the issue the change items are associated with, not null.changeItemFieldName
- the field name the change item is stored under, not null or empty.since
- only change items created after this date will be returned, not null.List<ChangeHistory> getChangeItemsWithFieldsForIssues(Iterable<Issue> issues, Iterable<String> fieldNames)
issues
- The list of issues to searchfieldNames
- The list of field namesList<ChangeHistoryItem> getAllChangeItems(Issue issue)
ChangeHistoryItem
's for the given issue.
Items in the returned list are ordered ascending by creation date any id.issue
- the issue@Nullable ChangeHistory getChangeHistoryById(Long changeGroupId)
Collection<Issue> findUserHistory(ApplicationUser remoteUser, Collection<String> userkeys, int maxResults)
remoteUser
- The user executing this request.userkeys
- The keys of users to find the history for. If null, returns the history for all users. If empty,
no results will be found.maxResults
- The maxmimum number of issues to returnCollection<Issue> findUserHistory(ApplicationUser remoteUser, Collection<String> userkeys, Collection<Project> projects, int maxResults)
remoteUser
- The user executing this request.userkeys
- The keys of users to find the history for. If null, returns the history for all users. If empty,
no results will be found.projects
- The projects to include issues frommaxResults
- The maxmimum number of issues to returnCollection<Issue> findUserHistory(ApplicationUser remoteUser, Collection<String> userkeys, Collection<Project> projects, int maxResults, @Nullable Date oldestUpdateTime)
remoteUser
- The user executing this request.userkeys
- The keys of users to find the history for. If null, returns the history for all users. If empty,
no results will be found.projects
- The projects to include issues frommaxResults
- The maxmimum number of issues to returnoldestUpdateTime
- issues updated prior to this time will not be included in the resultvoid removeAllChangeItems(Issue issue)
issue
- affected issueCopyright © 2002-2022 Atlassian. All Rights Reserved.