Package com.atlassian.jira.event.commit

Interface OnCommitEvent<T>

All Known Subinterfaces:

OnCommitEvent.OnCommitEventTransactionStatusSettable<E>, OnCommitIssueEvent, OnCommitJiraIssueEvent

@ExperimentalApi
public interface OnCommitEvent<T>

Base type for the OnCommit events

Since:

v7.4.0

See Also:

• OnCommitIssueEvent
• OnCommitJiraIssueEvent
• OnCommitEventManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OnCommitEvent.OnCommitEventDataReloadStatus	Used to indicate to consumers of OnCommitEvent whether the data contained in event was reloaded after commit or not.
static enum	OnCommitEvent.OnCommitEventTransactionStatus	Used to indicate to consumers of OnCommitEvent whether this event was actually published after a transaction commit, or if it was sent immediately, as not inside a transaction.
static interface	OnCommitEvent.OnCommitEventTransactionStatusSettable<E>	An implementable event for external developer that may wish to publish an OnCommitEvent and be able to update the OnCommitEvent.OnCommitEventTransactionStatus once it is known

Method Summary

Modifier and Type	Method	Description
default OnCommitEvent.OnCommitEventDataReloadStatus	getOnCommitEventDataReloadStatus()	Use this as an indication as to whether the data contained in this event has been reloaded after the commit, and therefore can be considered current.
default OnCommitEvent.OnCommitEventTransactionStatus	getOnCommitEventTransactionStatus()	Use this to check whether this event was published inside a transaction, and there actual event publishing was actually delayed until the transaction completed.
T	getWrappedEvent()	Returns the underlying wrapped event for this OnCommitEvent.

Method Details

getWrappedEvent

@Nonnull
T getWrappedEvent()

Returns the underlying wrapped event for this OnCommitEvent.

Returns:

The wrapped event associated with this OnCommitEvent

See Also:

• IssueEvent
• JiraIssueEvent

getOnCommitEventDataReloadStatus

@Nonnull
default OnCommitEvent.OnCommitEventDataReloadStatus getOnCommitEventDataReloadStatus()

Use this as an indication as to whether the data contained in this event has been reloaded after the commit, and therefore can be considered current.

It is up to the caller to set this value, as otherwise the default is OnCommitEvent.OnCommitEventDataReloadStatus.UNSPECIFIED

Returns:

The data reload status for this event

getOnCommitEventTransactionStatus

@Nonnull
default OnCommitEvent.OnCommitEventTransactionStatus getOnCommitEventTransactionStatus()

Use this to check whether this event was published inside a transaction, and there actual event publishing was actually delayed until the transaction completed.

This status should be set by the system when event is actually published

Returns:

The transaction status for this event