|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EventDispatchOption
This is a simple interface which allows us to define an event dispatch strategey 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. TheDO_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.
Nested Class Summary | |
---|---|
static class |
EventDispatchOption.EventDispatchOptionImpl
|
static class |
EventDispatchOption.Factory
A simple convienience object that will allow you to easily construct a EventDispatchOption. |
Field Summary | |
---|---|
static EventDispatchOption |
DO_NOT_DISPATCH
Use this when you do not want an event to be dispatched. |
static EventDispatchOption |
ISSUE_DELETED
Use this when you want to dispatch an EventType.ISSUE_DELETED_ID event. |
static EventDispatchOption |
ISSUE_UPDATED
Use this when you want to dispatch an EventType.ISSUE_UPDATED_ID
event. |
Method Summary | |
---|---|
java.lang.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 |
---|
static final EventDispatchOption DO_NOT_DISPATCH
static final EventDispatchOption ISSUE_UPDATED
EventType.ISSUE_UPDATED_ID
event.
static final EventDispatchOption ISSUE_DELETED
EventType.ISSUE_DELETED_ID
event.
Method Detail |
---|
boolean isEventBeingSent()
getEventTypeId()
will be used.
java.lang.Long getEventTypeId()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |