@ExperimentalApi public interface

HistoryMetadataManager

com.atlassian.jira.issue.changehistory.metadata.HistoryMetadataManager
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Allows storing and retrieving metadata related to issue history entries.

Summary

Nested Classes
class HistoryMetadataManager.HistoryMetadataResult Holds the information about retrieving history metadata, or errors encountered  
Public Methods
HistoryMetadataManager.HistoryMetadataResult getHistoryMetadata(ChangeHistory changeHistory, ApplicationUser user)
Retrieves the HistoryMetadata related to the ChangeHistory.
HistoryMetadataManager.HistoryMetadataResult getHistoryMetadata(long changeHistoryId)
Retrieves the HistoryMetadata releated to the ChangeHistory with the given id.
void saveHistoryMetadata(Long changeGroupId, ApplicationUser user, HistoryMetadata historyMetadata)
Persists the HistoryMetadata related to the change group.

Public Methods

public HistoryMetadataManager.HistoryMetadataResult getHistoryMetadata (ChangeHistory changeHistory, ApplicationUser user)

Retrieves the HistoryMetadata related to the ChangeHistory.

Parameters
changeHistory the change history to get the metadata for
user the user retrieving the information (requires the VIEW_ISSUE permission for the associated issue), null if anonymous
Returns
  • a HistoryMetadataResult with either the HistoryMetadata, or errors

public HistoryMetadataManager.HistoryMetadataResult getHistoryMetadata (long changeHistoryId)

Retrieves the HistoryMetadata releated to the ChangeHistory with the given id. Doesn't check any permissions

Parameters
changeHistoryId the changehistory id to get the metadata for
Returns
  • a HistoryMetadataResult with either the HistoryMetadata, or empty

public void saveHistoryMetadata (Long changeGroupId, ApplicationUser user, HistoryMetadata historyMetadata)

Persists the HistoryMetadata related to the change group. Does not check permissions for the entity being stored.

Parameters
changeGroupId the id of the changegroup to save the metadata for
user the user that performed the change, null if anonymous
historyMetadata the metadata to persist