com.atlassian.jira.issue.changehistory

Interface ChangeHistoryManager

All Known Implementing Classes:

DefaultChangeHistoryManager

@PublicApi
public interface ChangeHistoryManager

Manages the change history of issues. TODO: expand this interface to include the functionality from ChangeLogUtils

Method Summary

Modifier and Type	Method and Description
Map<String,String>	findAllPossibleValues(String field) Deprecated. since 5.2 - and will be removed in 6.0, it sucks performance wise and can kill a JIRA instance if you really need to find all values then use JiraLuceneFieldFinder
Issue	findMovedIssue(String originalKey) Deprecated. Use IssueManager.getIssue(String) instead. Since v6.1.
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, 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>	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's 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.
Collection<String>	getPreviousIssueKeys(Long issueId) Deprecated. Use IssueManager.getAllIssueKeys(Long) instead. Since v6.1.
Collection<String>	getPreviousIssueKeys(String issueKey) Deprecated. Use IssueManager.getAllIssueKeys(Long) instead. Since v6.1.
void	removeAllChangeItems(Issue issue) Remove all change items associated with an issue.

Method Detail

getChangeHistories

List<ChangeHistory> getChangeHistories(Issue issue)

Returns a List of ChangeHistory entities

Parameters:

issue - the issue.

Returns:

a List of ChangeHistory entries.

getChangeHistoriesSince

@Nonnull
List<ChangeHistory> getChangeHistoriesSince(@Nonnull
                                                     Issue issue,
                                                     @Nonnull
                                                     Date since)

Returns a List of ChangeHistory entities that occurred after the provided date.

Parameters:

issue - the issue. Must not be null.

since - only change histories made after this date will be returned. Must not be null.

Returns:

a possibly empty List of ChangeHistory entries made after the provided date. Will not be null.

Since:

v6.3

getChangeHistoriesForUser

List<ChangeHistory> getChangeHistoriesForUser(Issue issue,
                                              ApplicationUser remoteUser)

Returns a List of ChangeHistory entities for a single issue.

Parameters:

issue - the issue.

remoteUser - the user who is asking.

Returns:

a List of ChangeHistory entries.

See Also:

for a more efficient way to read change histories for multiple issues

getChangeHistoriesForUser

List<ChangeHistory> getChangeHistoriesForUser(Iterable<Issue> issues,
                                              ApplicationUser remoteUser)

Returns a List of ChangeHistory entities for multiple issues. This method is much more efficient than #getChangeHistoriesForUser(com.atlassian.jira.issue.Issue, com.atlassian.crowd.embedded.api.User) and should be prefered whenever possible.

Parameters:

issues - the issues.

remoteUser - the user who is asking.

Returns:

a List of ChangeHistory entries.

Since:

v5.1

getChangeItemsForField

List<ChangeItemBean> getChangeItemsForField(Issue issue,
                                            String changeItemFieldName)

Returns a List of ChangeItemBean's for the given issue which also are for the provided changeItemFieldName (i.e. Link, Fix Version/s, etc). The order of the list will from oldest to newest.

Parameters:

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.

Returns:

a List of ChangeItemBean's for the given issue.

getChangeItemsWithFieldsForIssues

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.

Parameters:

issues - The list of issues to search

fieldNames - The list of field names

Returns:

A list of changes.

Since:

v7.1

getAllChangeItems

List<ChangeHistoryItem> getAllChangeItems(Issue issue)

Returns a List of ChangeHistoryItem's for the given issue

Parameters:

issue - the issue

Returns:

A list containing all of the change items for a specific Issue

getChangeHistoryById

@Nullable
ChangeHistory getChangeHistoryById(Long changeGroupId)

Returns:

a ChangeHistory group with the given id, or null if not found

Since:

v6.3

findMovedIssue

@Deprecated
Issue findMovedIssue(String originalKey)
                          throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use IssueManager.getIssue(String) instead. Since v6.1.

Returns an issue that has been moved by searching on the old issue key.

Parameters:

originalKey - the original key of an issue that has since been moved (moving between projects assigns a new key to an issue)

Returns:

the moved Issue object

Throws:

org.ofbiz.core.entity.GenericEntityException - if an unexpected error occurs

getPreviousIssueKeys

@Deprecated
Collection<String> getPreviousIssueKeys(String issueKey)

Deprecated. Use IssueManager.getAllIssueKeys(Long) instead. Since v6.1.

Given an issue key, this method returns a list of previous issue keys this issue was moved from. This may be useful for source control plugins for example, where a given changeset should be displayed even after an issue has been moved and it's issue key has changed.

Note: The list of previous issue keys is no longer returned in chronological order.

Parameters:

issueKey - The current issue key.

Returns:

A collection of previous issue keys or an empty list if none exist.

getPreviousIssueKeys

@Deprecated
Collection<String> getPreviousIssueKeys(Long issueId)

Deprecated. Use IssueManager.getAllIssueKeys(Long) instead. Since v6.1.

Returns the same as getPreviousIssueKeys(String) but is slightly more efficient since no lookup of the issue id needs to be performed. If you have an issue object available with the issue's id use this method.

Parameters:

issueId - The id of the issue being looked up.

Returns:

A collection of previous issue keys or an empty list if none exist.

findUserHistory

Collection<Issue> findUserHistory(ApplicationUser remoteUser,
                                  Collection<String> userkeys,
                                  int maxResults)

Find a list of issues that the given users have acted on.

Parameters:

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 return

Returns:

An immutable collection of issue objects sorted by creation date in descending order

Since:

v4.0

findUserHistory

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.

Parameters:

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 from

maxResults - The maxmimum number of issues to return

Returns:

An immutable collection of issue objects sorted by creation date in descending order

Since:

v4.3

findAllPossibleValues

Map<String,String> findAllPossibleValues(String field)

Deprecated. since 5.2 - and will be removed in 6.0, it sucks performance wise and can kill a JIRA instance if you really need to find all values then use JiraLuceneFieldFinder

Find a map of all names ever used in the change history.

Parameters:

field - The field name.

Returns:

An immutable map of issue objects sorted by creation date in descending order

Since:

v4.3

removeAllChangeItems

void removeAllChangeItems(Issue issue)

Remove all change items associated with an issue.

Parameters:

issue - affected issue