@PublicApi
public interface EventTypeManager
Used to add, edit, delete and retrieve event types.
Modifier and Type | Method and Description |
---|---|
void |
addEventType(EventType eventType) |
void |
clearCache() |
void |
deleteEventType(Long eventTypeId) |
void |
editEventType(Long eventTypeId,
String name,
String description,
Long templateId) |
Map<Long,String> |
getAssociatedNotificationSchemes(EventType eventType)
Return a mapping of notification scheme ID to its name for each notification scheme that is associated
with the specified
eventType |
org.apache.commons.collections.MultiMap |
getAssociatedWorkflows(EventType eventType,
boolean statusCheck)
Determines which workflows and transitions are associated with the specified eventType.
|
EventType |
getEventType(Long id)
Returns the event type with the specified
id |
Collection<EventType> |
getEventTypes()
Returns an immutable collection of all known event types.
|
Map<Long,EventType> |
getEventTypesMap()
Returns an immutable map of all known event type IDs to the corresponding event types.
|
boolean |
isActive(EventType eventType)
Determine if the specified
eventType is associated with any workflow or notification scheme. |
boolean |
isEventTypeExists(Long eventTypeId) |
boolean |
isEventTypeExists(String eventTypeName) |
Collection<EventType> getEventTypes()
This convenience method is exactly equivalent to
getEventTypesMap()
.values()
.
Map<Long,EventType> getEventTypesMap()
EventType getEventType(Long id)
id
id
- The ID of the desired event typeid
IllegalArgumentException
- if the specified event type does not existboolean isActive(EventType eventType)
eventType
is associated with any workflow or notification scheme.eventType
- event typetrue
if eventType
is associated with any workflow or notification
scheme; false
otherwise.org.apache.commons.collections.MultiMap getAssociatedWorkflows(EventType eventType, boolean statusCheck)
The event type can be associated with a workflow through a post function on any of the workflow transitions.
eventType
- event typestatusCheck
- option to break on first association discovered - used when checking if event type is activeWorkflowTransitionKey
s to transitionsMap<Long,String> getAssociatedNotificationSchemes(EventType eventType)
eventType
The event type is associated with a notification scheme if the scheme has at least one notification type and template selected for that event type.
eventType
- event typevoid addEventType(EventType eventType)
void editEventType(Long eventTypeId, String name, String description, Long templateId)
void deleteEventType(Long eventTypeId)
boolean isEventTypeExists(String eventTypeName)
boolean isEventTypeExists(Long eventTypeId)
void clearCache()
Copyright © 2002-2019 Atlassian. All Rights Reserved.