Package com.atlassian.jira.event.issue
Interface IssueEventBundleFactory
- All Known Implementing Classes:
IssueEventBundleFactoryImpl
public interface IssueEventBundleFactory
Factory to create
IssueEventBundle
objects.-
Method Summary
Modifier and TypeMethodDescriptioncreateCommentAddedBundle
(Issue issue, ApplicationUser user, Comment comment, Map<String, Object> params) Creates an IssueEventBundle for scenarios where a comment is added to an issue.createCommentDeletedBundle
(Issue issue, ApplicationUser user, Map params) Creates an IssueEventBundle for scenarios where a comment is deleted from an issue.createCommentEditedBundle
(Issue issue, ApplicationUser user, Comment comment, Map<String, Object> params) Creates an IssueEventBundle for scenarios where a comment is edited.createIssueArchivingRelatedEventBundle
(Issue issue, IssueUpdateBean iub, ApplicationUser user) createIssueDeleteEventBundle
(Issue issue, DefaultIssueDeleteHelper.DeletedIssueEventData deletedIssueEventData, ApplicationUser user) Creates an IssueEventBundle for scenarios where an issue is deleted.createIssueUpdateEventBundle
(Issue issue, org.ofbiz.core.entity.GenericValue changeGroup, IssueUpdateBean iub, ApplicationUser user) Creates an IssueEventBundle for scenarios where an issue has been updated.createWorkflowEventBundle
(Long eventType, Issue issue, ApplicationUser user, Comment comment, org.ofbiz.core.entity.GenericValue changeGroup, Map<String, Object> params, boolean sendMail, String originalAssigneeId) Creates an IssueEventBundle for scenarios where a workflow transition is executed.createWorklogEventBundle
(Issue issue, org.ofbiz.core.entity.GenericValue changeGroup, IssueUpdateBean iub, ApplicationUser applicationUser) Creates an IssueEventBundle for scenarios where the worklog of an issue has been updated.wrapInBundle
(IssueEvent issueEvent) Creates a IssueEventBundle that contains only one event equivalent to the given IssueEvent.
-
Method Details
-
createIssueUpdateEventBundle
IssueEventBundle createIssueUpdateEventBundle(Issue issue, org.ofbiz.core.entity.GenericValue changeGroup, IssueUpdateBean iub, ApplicationUser user) Creates an IssueEventBundle for scenarios where an issue has been updated.NB: When firing this event, also be sure to call
TxnAwareEventFactory.issueChangedEventOnCommit(long, ApplicationUser, Comment, long, boolean)
to ensure the correspondingIssueChangedEvent
is also fired.- Parameters:
issue
- The updated issuechangeGroup
- The group of changes applied to the issueiub
- The issue update bean containing all the information about the changes on the issueuser
- The user that made the issue update- Returns:
- The IssueEventBundle with all the events to be dispatched due to the issue update
-
createWorklogEventBundle
IssueEventBundle createWorklogEventBundle(Issue issue, org.ofbiz.core.entity.GenericValue changeGroup, IssueUpdateBean iub, ApplicationUser applicationUser) Creates an IssueEventBundle for scenarios where the worklog of an issue has been updated.- Parameters:
issue
- The updated issuechangeGroup
- The group of changes applied to the issueiub
- The issue update bean containing all the information about the changes on the issueuser
- The user that made the issue update- Returns:
- The IssueEventBundle with all the events to be dispatched due to the issue update
-
createIssueDeleteEventBundle
IssueEventBundle createIssueDeleteEventBundle(Issue issue, DefaultIssueDeleteHelper.DeletedIssueEventData deletedIssueEventData, ApplicationUser user) Creates an IssueEventBundle for scenarios where an issue is deleted.- Parameters:
issue
- The deleted issue issuedeletedIssueEventData
- An object encapsulating information about the delete operationuser
- The user that deleted the issue- Returns:
- The IssueEventBundle with all the events to be dispatched due to the issue deletion
-
createCommentAddedBundle
IssueEventBundle createCommentAddedBundle(Issue issue, ApplicationUser user, Comment comment, Map<String, Object> params) Creates an IssueEventBundle for scenarios where a comment is added to an issue.- Parameters:
issue
- The issue for which the comment was addeduser
- The user that added the commentcomment
- The comment that was addedparams
- Some extra parameters that can be passed to create the event.- Returns:
- The IssueEventBundle with all the events to be dispatched due to the new comment being added
-
createCommentEditedBundle
IssueEventBundle createCommentEditedBundle(Issue issue, ApplicationUser user, Comment comment, Map<String, Object> params) Creates an IssueEventBundle for scenarios where a comment is edited.- Parameters:
issue
- The issue for which the comment is edited.user
- The user that edited the commentcomment
- The comment that was editedparams
- Some extra parameters that can be passed to create the event.- Returns:
- The IssueEventBundle with all the events to be dispatched due to the comment being edited
-
createWorkflowEventBundle
IssueEventBundle createWorkflowEventBundle(Long eventType, Issue issue, ApplicationUser user, Comment comment, org.ofbiz.core.entity.GenericValue changeGroup, Map<String, Object> params, boolean sendMail, String originalAssigneeId) Creates an IssueEventBundle for scenarios where a workflow transition is executed.- Parameters:
eventType
- The type of the eventissue
- The issue that was transitioneduser
- The user that transitioned the issuecomment
- A comment that could have been added on the transitionchangeGroup
- The group of changes applied to the issueparams
- Some extra parameters that can be passed to create the event.sendMail
- A boolean indicating whether the IssueEventBundle can be sent by emailoriginalAssigneeId
- The identifier of the original assignee of the issue before the transition occurred- Returns:
- The IssueEventBundle with all the events to be dispatched due to the workflow transition
-
wrapInBundle
Creates a IssueEventBundle that contains only one event equivalent to the given IssueEvent.- Parameters:
issueEvent
- The given issue event to be wrapped on an IssueEventBundle- Returns:
- An IssueEventBundle wrapping the given IssueEvent
-
createIssueArchivingRelatedEventBundle
IssueEventBundle createIssueArchivingRelatedEventBundle(Issue issue, IssueUpdateBean iub, ApplicationUser user) -
createCommentDeletedBundle
Creates an IssueEventBundle for scenarios where a comment is deleted from an issue.- Parameters:
issue
- The issue for which the comment was deleteduser
- The user that deleted the commentparams
- parameters which must contain 'originalcomment' key with the deleted comment as a value- Returns:
- The IssueEventBundle with all the events to be dispatched due to the comment being deleted
-