com.atlassian.jira.issue.managers

Interface IssueArchiveHelper

All Known Implementing Classes:

DefaultIssueArchiveHelper, ZduAwareIssueArchiveHelper

public interface IssueArchiveHelper

Performs issue and project archiving.

Since:

v8.1

Method Summary

Modifier and Type	Method and Description
Issue	archiveIssue(ApplicationUser user, Issue issue, EventDispatchOption eventDispatchOption, boolean sendMail) Archive issue in context of given user.
void	archiveIssuesInProject(Project project) Marks all issues in the specified project as archived and de-indexes them.
boolean	isIssueArchived(Project project, boolean issueArchivedProperty) Returns if the issue is archived.
Issue	restoreIssue(ApplicationUser user, Issue issue, EventDispatchOption eventDispatchOption, boolean sendMail) Restores issue in context of given user.
void	restoreIssuesInProject(Project project) Restores all issues in the specified project, except the ones that had been individually marked as archived with archiveIssue(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.Issue, com.atlassian.jira.event.type.EventDispatchOption, boolean) prior to archiving the project with archiveIssuesInProject(com.atlassian.jira.project.Project).

Method Detail

isIssueArchived

boolean isIssueArchived(Project project,
                        boolean issueArchivedProperty)

Returns if the issue is archived. Takes into account the flag set on the issue, but also if the project is archived and if licensing allows archiving.

Returns:

true if issue is archived considering all the inputs

archiveIssue

Issue archiveIssue(ApplicationUser user,
                   Issue issue,
                   EventDispatchOption eventDispatchOption,
                   boolean sendMail)
            throws ArchiveException

Archive issue in context of given user.

Parameters:

user - user performing the operation

issue - issue to archive

eventDispatchOption - specifies if an event should be sent and if so which should be sent.

sendMail - whether to send the email

Throws:

ArchiveException

restoreIssue

Issue restoreIssue(ApplicationUser user,
                   Issue issue,
                   EventDispatchOption eventDispatchOption,
                   boolean sendMail)
            throws ArchiveException

Restores issue in context of given user.

Parameters:

user - user performing the operation

issue - issue to archive

eventDispatchOption - specifies if an event should be sent and if so which should be sent.

sendMail - whether to send the email

Throws:

ArchiveException

archiveIssuesInProject

void archiveIssuesInProject(Project project)

Marks all issues in the specified project as archived and de-indexes them.

Parameters:

project - project whose issues should be archived

Since:

v9.6

restoreIssuesInProject

void restoreIssuesInProject(Project project)

Restores all issues in the specified project, except the ones that had been individually marked as archived with archiveIssue(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.Issue, com.atlassian.jira.event.type.EventDispatchOption, boolean) prior to archiving the project with archiveIssuesInProject(com.atlassian.jira.project.Project). This method does not reindex the restored issues, it just marks them as not archived in the database.

Parameters:

project - project whose issues should be restored

Since:

v9.6