@PublicApi public interface

EventDispatchOption

com.atlassian.jira.event.type.EventDispatchOption
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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 ISSUE_UPDATED_ID event.

Summary

Nested Classes
class EventDispatchOption.EventDispatchOptionImpl  
class EventDispatchOption.Factory A simple convienience object that will allow you to easily construct a EventDispatchOption. 
Fields
public static final EventDispatchOption DO_NOT_DISPATCH Use this when you do not want an event to be dispatched.
public static final EventDispatchOption ISSUE_ASSIGNED Use this when you want to dispatch an ISSUE_ASSIGNED_ID event.
public static final EventDispatchOption ISSUE_DELETED Use this when you want to dispatch an ISSUE_DELETED_ID event.
public static final EventDispatchOption ISSUE_UPDATED Use this when you want to dispatch an ISSUE_UPDATED_ID event.
Public Methods
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.

Fields

public static final EventDispatchOption DO_NOT_DISPATCH

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

public static final EventDispatchOption ISSUE_ASSIGNED

Use this when you want to dispatch an ISSUE_ASSIGNED_ID event.

public static final EventDispatchOption ISSUE_DELETED

Use this when you want to dispatch an ISSUE_DELETED_ID event.

public static final EventDispatchOption ISSUE_UPDATED

Use this when you want to dispatch an ISSUE_UPDATED_ID event.

Public Methods

public 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!

public boolean isEventBeingSent ()

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