public class

ChangeLogUtils

extends Object
java.lang.Object
   ↳ com.atlassian.jira.issue.history.ChangeLogUtils

Class Overview

Utility methods for managing ChangeGroup entities on issues, also known as the Change Log or Change History.

TODO: Migrate methods to ChangeHistoryManager and deprecate

Summary

Public Constructors
ChangeLogUtils()
Public Methods
static GenericValue createChangeGroup(ApplicationUser changeAuthor, GenericValue before, GenericValue after, Collection<ChangeItemBean> incomingChangeItems, boolean generateChangeItems)
Writes the given field changes to the db and optionally a changelog.
static GenericValue createChangeGroup(User changeAuthor, GenericValue before, GenericValue after, Collection<ChangeItemBean> incomingChangeItems, boolean generateChangeItems)
This method is deprecated. Use createChangeGroup(com.atlassian.jira.user.ApplicationUser, org.ofbiz.core.entity.GenericValue, org.ofbiz.core.entity.GenericValue, java.util.Collection, boolean) instead. Since v6.0.
static GenericValue createChangeGroup(ApplicationUser changeAuthor, Issue before, Issue after, Collection<ChangeItemBean> incomingChangeItems, boolean generateChangeItems)
This method is deprecated. Use createChangeGroup(com.atlassian.jira.user.ApplicationUser, org.ofbiz.core.entity.GenericValue, org.ofbiz.core.entity.GenericValue, java.util.Collection, boolean) instead. Since v6.0.
static GenericValue createChangeGroup(User changeAuthor, Issue before, Issue after, Collection<ChangeItemBean> incomingChangeItems, boolean generateChangeItems)
This method is deprecated. Use createChangeGroup(com.atlassian.jira.user.ApplicationUser, org.ofbiz.core.entity.GenericValue, org.ofbiz.core.entity.GenericValue, java.util.Collection, boolean) instead. Since v6.0.
@Deprecated static void deleteChangesForIssue(GenericValue issue)
This method is deprecated. use removeAllChangeItems(com.atlassian.jira.issue.Issue) instead.
static ChangeItemBean generateChangeItem(GenericValue before, GenericValue after, String fieldname)
static List<ChangeItemBean> generateChangeItems(GenericValue before, GenericValue after)
Returns a List of ChangeItemBean objects for each of the relevant fields that differ between the two issues.
static ChangeItemBean generateSecurityChangeItem(String fieldname, String from, String to)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ChangeLogUtils ()

Public Methods

public static GenericValue createChangeGroup (ApplicationUser changeAuthor, GenericValue before, GenericValue after, Collection<ChangeItemBean> incomingChangeItems, boolean generateChangeItems)

Writes the given field changes to the db and optionally a changelog.

Parameters
changeAuthor the ApplicationUser making the change.
before The issue before the update.
after This issue after the update.
incomingChangeItems Some ChangeItemBean.
generateChangeItems if true, a changelog is actually generated.
Returns
  • the ChangeGroup GenericValue

public static GenericValue createChangeGroup (User changeAuthor, GenericValue before, GenericValue after, Collection<ChangeItemBean> incomingChangeItems, boolean generateChangeItems)

This method is deprecated.
Use createChangeGroup(com.atlassian.jira.user.ApplicationUser, org.ofbiz.core.entity.GenericValue, org.ofbiz.core.entity.GenericValue, java.util.Collection, boolean) instead. Since v6.0.

Writes the given field changes to the db and optionally a changelog.

Parameters
changeAuthor the User making the change.
before The issue before the update.
after This issue after the update.
incomingChangeItems Some ChangeItemBean.
generateChangeItems if true, a changelog is actually generated.
Returns
  • the ChangeGroup GenericValue

public static GenericValue createChangeGroup (ApplicationUser changeAuthor, Issue before, Issue after, Collection<ChangeItemBean> incomingChangeItems, boolean generateChangeItems)

This method is deprecated.
Use createChangeGroup(com.atlassian.jira.user.ApplicationUser, org.ofbiz.core.entity.GenericValue, org.ofbiz.core.entity.GenericValue, java.util.Collection, boolean) instead. Since v6.0.

Writes the given field changes to the db and optionally a changelog.

Parameters
changeAuthor the ApplicationUser making the change.
before The issue before the update.
after This issue after the update.
incomingChangeItems Some ChangeItemBean.
generateChangeItems if true, a changelog is actually generated.
Returns
  • the ChangeGroup GenericValue

public static GenericValue createChangeGroup (User changeAuthor, Issue before, Issue after, Collection<ChangeItemBean> incomingChangeItems, boolean generateChangeItems)

This method is deprecated.
Use createChangeGroup(com.atlassian.jira.user.ApplicationUser, org.ofbiz.core.entity.GenericValue, org.ofbiz.core.entity.GenericValue, java.util.Collection, boolean) instead. Since v6.0.

Parameters
changeAuthor the User making the change.
before The issue before the update.
after This issue after the update.
incomingChangeItems Some ChangeItemBean.
generateChangeItems if true, a changelog is actually generated.
Returns
  • the ChangeGroup GenericValue

@Deprecated public static void deleteChangesForIssue (GenericValue issue)

This method is deprecated.
use removeAllChangeItems(com.atlassian.jira.issue.Issue) instead.

Deletes all the change groups and change items associated with the provided issue.

Parameters
issue represents the issue that is being deleted

public static ChangeItemBean generateChangeItem (GenericValue before, GenericValue after, String fieldname)

public static List<ChangeItemBean> generateChangeItems (GenericValue before, GenericValue after)

Returns a List of ChangeItemBean objects for each of the relevant fields that differ between the two issues.

Parameters
before A GenericValue for the issue before the change.
after A GenericValue for the issue after the change.
Returns
  • the list of ChangeItemBeans.

public static ChangeItemBean generateSecurityChangeItem (String fieldname, String from, String to)