com.atlassian.jira.project.archiving

Interface ArchivedProjectService

All Known Implementing Classes:

DefaultArchivedProjectService

@ExperimentalApi
public interface ArchivedProjectService

This service can be used for archiving projects and restoring projects.

Since:

7.9

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
ArchivedProjectService.ArchivingResult	archiveProject(ArchivedProjectService.ValidationResult validation) Mark the project as archived and perform operation of archiving including all dependencies.
ArchivedProjectService.ArchivingResult	restoreProject(ArchivedProjectService.ValidationResult validation) Mark the project as not archived.
ArchivedProjectService.ValidationResult	validateArchiveProject(ApplicationUser user, String projectKey) Check if given project can be archived by given user.
ArchivedProjectService.ValidationResult	validateRestoreProject(ApplicationUser user, String projectKey) Check if given project can be restored by given user.

Method Detail

archiveProject

ArchivedProjectService.ArchivingResult archiveProject(ArchivedProjectService.ValidationResult validation)

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

Parameters:

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

Returns:

the result of the operation.

validateArchiveProject

ArchivedProjectService.ValidationResult validateArchiveProject(ApplicationUser user,
                                                               String projectKey)

Check if given project can be archived by given user.

Parameters:

user -

projectKey -

Returns:

the validation result.

restoreProject

ArchivedProjectService.ArchivingResult restoreProject(ArchivedProjectService.ValidationResult validation)

Mark the project as not archived. This method will also trigger ProjectRestoredEvent.

Parameters:

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

Returns:

the result of the operation.

validateRestoreProject

ArchivedProjectService.ValidationResult validateRestoreProject(ApplicationUser user,
                                                               String projectKey)

Check if given project can be restored by given user.

Parameters:

user -

projectKey -

Returns:

the validation result.