Package com.atlassian.jira.issue.archiving

Interface ArchivedIssueService

All Known Implementing Classes:

DefaultArchivedIssueService

@ExperimentalApi
public interface ArchivedIssueService

This service can be used for archiving and restoring individual issues.

Since:

8.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ArchivedIssueService.ArchivingResult	A simple object that holds the information about an issue archive/restore operation.
static class	ArchivedIssueService.ValidationResult	A simple object that holds the information about validating an archive/restore issue operation.

Method Summary

Modifier and Type	Method	Description
ArchivedIssueService.ArchivingResult	archiveIssue(ArchivedIssueService.ValidationResult validation)	Mark the issue as archived and perform operation of archiving including all dependencies.
ArchivedIssueService.ArchivingResult	restoreIssue(ArchivedIssueService.ValidationResult validation)	Mark the issue as not archived and perform operation of restoring including all dependencies.
ArchivedIssueService.ValidationResult	validateArchiveIssue(ApplicationUser user, String issueKey, boolean notifyUsers)	Check if given issue can be archived by given user.
ArchivedIssueService.ValidationResult	validateRestoreIssue(ApplicationUser user, String issueKey, boolean notifyUsers)	Check if given issue can be restored by given user.

Method Details

archiveIssue

ArchivedIssueService.ArchivingResult archiveIssue(ArchivedIssueService.ValidationResult validation)

Mark the issue as archived and perform operation of archiving including all dependencies. This method will also trigger IssuesArchivedEvent.

Parameters:

validation - a request previously validated by validateArchiveIssue(ApplicationUser, String, boolean).

Returns:

the result of the operation.

restoreIssue

ArchivedIssueService.ArchivingResult restoreIssue(ArchivedIssueService.ValidationResult validation)

Mark the issue as not archived and perform operation of restoring including all dependencies. This method will also trigger IssuesRestoredEvent.

Parameters:

validation - a request previously validated by validateRestoreIssue(ApplicationUser, String, boolean).

Returns:

the result of the operation.

validateArchiveIssue

ArchivedIssueService.ValidationResult validateArchiveIssue(ApplicationUser user,
 String issueKey,
 boolean notifyUsers)

Check if given issue can be archived by given user.

Parameters:

user -

issueKey -

notifyUsers -

Returns:

the validation result.

validateRestoreIssue

ArchivedIssueService.ValidationResult validateRestoreIssue(ApplicationUser user,
 String issueKey,
 boolean notifyUsers)

Check if given issue can be restored by given user.

Parameters:

user -

issueKey -

notifyUsers -

Returns:

the validation result.