com.atlassian.jira.issue.changehistory.metadata

Interface HistoryMetadataManager

All Known Implementing Classes:

DefaultHistoryMetadataManager

@ExperimentalApi
public interface HistoryMetadataManager

Allows storing and retrieving metadata related to issue history entries.

Since:

JIRA 6.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HistoryMetadataManager.HistoryMetadataResult Holds the information about retrieving history metadata, or errors encountered

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

saveHistoryMetadata

void saveHistoryMetadata(@Nonnull
                         Long changeGroupId,
                         @Nullable
                         ApplicationUser user,
                         @Nonnull
                         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

Since:

JIRA 6.3

getHistoryMetadata

HistoryMetadataManager.HistoryMetadataResult getHistoryMetadata(@Nonnull
                                                                ChangeHistory changeHistory,
                                                                @Nullable
                                                                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

Since:

JIRA 6.3

getHistoryMetadata

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

Since:

JIRA 6.3