com.atlassian.jira.event.type

Interface EventDispatchOption

All Known Implementing Classes:

EventDispatchOption.EventDispatchOptionImpl

@PublicApi
public interface EventDispatchOption

Defines an event dispatch strategy to use when updating issues.

A client caller may want to skip dispatching an event or they may want to specify which event should be fired.

The DO_NOT_DISPATCH event is to be used if an event should not be dispatched. ISSUE_UPDATED is the default behavior and will dispatch a EventType.ISSUE_UPDATED_ID event.

Since:

v4.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EventDispatchOption.EventDispatchOptionImpl
static class	EventDispatchOption.Factory A simple convenience object that will allow you to easily construct an EventDispatchOption.

Field Summary

Fields

Modifier and Type	Field and Description
static EventDispatchOption	DO_NOT_DISPATCH Use this when you do not want an event to be dispatched.
static EventDispatchOption	ISSUE_ARCHIVED Use this when you want to dispatch an EventType.ISSUE_ARCHIVED_ID event.
static EventDispatchOption	ISSUE_ASSIGNED Use this when you want to dispatch an EventType.ISSUE_ASSIGNED_ID event.
static EventDispatchOption	ISSUE_DELETED Use this when you want to dispatch an EventType.ISSUE_DELETED_ID event.
static EventDispatchOption	ISSUE_RESTORED Use this when you want to dispatch an EventType.ISSUE_RESTORED_ID event.
static EventDispatchOption	ISSUE_UPDATED Use this when you want to dispatch an EventType.ISSUE_UPDATED_ID event.

Method Summary

Modifier and Type	Method and Description
Long	getEventTypeId() Used to specify the event type this option is configured to express.
boolean	isEventBeingSent() This should be false if you do not want to dispatch an event, otherwise the event specified by getEventTypeId() will be used.

Field Detail

DO_NOT_DISPATCH

static final EventDispatchOption DO_NOT_DISPATCH

Use this when you do not want an event to be dispatched.

ISSUE_UPDATED

static final EventDispatchOption ISSUE_UPDATED

Use this when you want to dispatch an EventType.ISSUE_UPDATED_ID event.

ISSUE_ASSIGNED

static final EventDispatchOption ISSUE_ASSIGNED

Use this when you want to dispatch an EventType.ISSUE_ASSIGNED_ID event.

ISSUE_DELETED

static final EventDispatchOption ISSUE_DELETED

Use this when you want to dispatch an EventType.ISSUE_DELETED_ID event.

ISSUE_ARCHIVED

static final EventDispatchOption ISSUE_ARCHIVED

Use this when you want to dispatch an EventType.ISSUE_ARCHIVED_ID event.

ISSUE_RESTORED

static final EventDispatchOption ISSUE_RESTORED

Use this when you want to dispatch an EventType.ISSUE_RESTORED_ID event.

Method Detail

isEventBeingSent

boolean isEventBeingSent()

This should be false if you do not want to dispatch an event, otherwise the event specified by getEventTypeId() will be used.

getEventTypeId

Long getEventTypeId()

Used to specify the event type this option is configured to express.

Returns:

a legal eventTypeId. Must not be null if isEventBeingSent() returns true!