com.atlassian.jira.issue.managers

Class DefaultIssueArchiveHelper

java.lang.Object

com.atlassian.jira.issue.managers.DefaultIssueArchiveHelper

All Implemented Interfaces:

IssueArchiveHelper

public class DefaultIssueArchiveHelper
extends Object
implements IssueArchiveHelper

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARCHIVED_CHANGEITEM
static String	RESTORED_CHANGEITEM

Constructor Summary

Constructors

Constructor and Description

DefaultIssueArchiveHelper(IssueManager issueManager, IssueUpdater issueUpdater, IssueIndexingService issueIndexingService, ArchivedStatistics archivedStatistics, ArchivingLicenseCheck archivingLicenseCheck, IssueEventManager issueEventManager, IssueEventBundleFactory issueEventBundleFactory, com.atlassian.event.api.EventPublisher eventPublisher, IssueStateAuditHandler issueStateAuditHandler, EntityVersioningManager entityVersioningManager, ReplicatedIndexManager replicatedIndexManager, ArchivingDao archivingDao)

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.
protected boolean	isArchivingAllowed()
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 IssueArchiveHelper.archiveIssue(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.Issue, com.atlassian.jira.event.type.EventDispatchOption, boolean) prior to archiving the project with IssueArchiveHelper.archiveIssuesInProject(com.atlassian.jira.project.Project).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARCHIVED_CHANGEITEM

public static final String ARCHIVED_CHANGEITEM

See Also:

Constant Field Values

RESTORED_CHANGEITEM

public static final String RESTORED_CHANGEITEM

See Also:

Constant Field Values

Constructor Detail

DefaultIssueArchiveHelper

public DefaultIssueArchiveHelper(IssueManager issueManager,
                                 IssueUpdater issueUpdater,
                                 IssueIndexingService issueIndexingService,
                                 ArchivedStatistics archivedStatistics,
                                 ArchivingLicenseCheck archivingLicenseCheck,
                                 IssueEventManager issueEventManager,
                                 IssueEventBundleFactory issueEventBundleFactory,
                                 com.atlassian.event.api.EventPublisher eventPublisher,
                                 IssueStateAuditHandler issueStateAuditHandler,
                                 EntityVersioningManager entityVersioningManager,
                                 ReplicatedIndexManager replicatedIndexManager,
                                 ArchivingDao archivingDao)

Method Detail

isIssueArchived

public boolean isIssueArchived(Project project,
                               boolean issueArchivedProperty)

Description copied from interface: IssueArchiveHelper

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.

Specified by:

isIssueArchived in interface IssueArchiveHelper

Returns:

true if issue is archived considering all the inputs

archiveIssue

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

Description copied from interface: IssueArchiveHelper

Archive issue in context of given user.

Specified by:

archiveIssue in interface IssueArchiveHelper

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

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

Description copied from interface: IssueArchiveHelper

Restores issue in context of given user.

Specified by:

restoreIssue in interface IssueArchiveHelper

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

public void archiveIssuesInProject(Project project)

Description copied from interface: IssueArchiveHelper

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

Specified by:

archiveIssuesInProject in interface IssueArchiveHelper

Parameters:

project - project whose issues should be archived

restoreIssuesInProject

public void restoreIssuesInProject(Project project)

Description copied from interface: IssueArchiveHelper

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

Specified by:

restoreIssuesInProject in interface IssueArchiveHelper

Parameters:

project - project whose issues should be restored

isArchivingAllowed

protected boolean isArchivingAllowed()