com.atlassian.jira.issue.archiving

Class DefaultArchivedIssueSearchService

java.lang.Object

com.atlassian.jira.issue.archiving.DefaultArchivedIssueSearchService

All Implemented Interfaces:

ArchivedIssueSearchService

public class DefaultArchivedIssueSearchService
extends Object
implements ArchivedIssueSearchService

Class for searching archived issues in Jira

Since:

v8.1

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.issue.archiving.ArchivedIssueSearchService

ArchivedIssueSearchService.ArchiveSearchRequest, ArchivedIssueSearchService.ValidationResult

Constructor Summary

Constructors

Constructor and Description

DefaultArchivedIssueSearchService(IssueFactory issueFactory, ProjectManager projectManager, OfBizDelegator ofBizDelegator, GlobalPermissionManager globalPermissionManager, JiraAuthenticationContext authenticationContext, ProjectService projectService, I18nHelper.BeanFactory i18nFactory, ConstantsManager constantsManager, ArchivedIssuesProvider archivedIssuesProvider, PermissionManager permissionManager)

Method Summary

Modifier and Type	Method and Description
boolean	archivedProjectsOrIssuesExist()
int	count(ArchivedIssueSearchService.ValidationResult validationResult) Count number of issues in archive using given criteria.
List<Issue>	getArchivedIssuesMatchingTypesInProjects(List<Long> projectIds, List<String> issueTypeIds) For the projects specified by projectIds, finds archived issues that are of the types given by issueTypIds.
static io.atlassian.fugue.Either<Long,String>	parse(String projectKeyOrId)
java.util.stream.Stream<ArchivedIssue>	search(ArchivedIssueSearchService.ValidationResult validationResult) Search for issues in archive using given criteria.
ArchivedIssueSearchService.ValidationResult	validateSearch(ArchivedIssueSearchService.ArchiveSearchRequest request) Validate search request
ArchivedIssueSearchService.ValidationResult	validateSearchOverrideSecurity(ArchivedIssueSearchService.ArchiveSearchRequest request) Validate search request not taking into account any security

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultArchivedIssueSearchService

public DefaultArchivedIssueSearchService(IssueFactory issueFactory,
                                         ProjectManager projectManager,
                                         OfBizDelegator ofBizDelegator,
                                         GlobalPermissionManager globalPermissionManager,
                                         JiraAuthenticationContext authenticationContext,
                                         ProjectService projectService,
                                         I18nHelper.BeanFactory i18nFactory,
                                         ConstantsManager constantsManager,
                                         ArchivedIssuesProvider archivedIssuesProvider,
                                         PermissionManager permissionManager)

Method Detail

getArchivedIssuesMatchingTypesInProjects

public List<Issue> getArchivedIssuesMatchingTypesInProjects(List<Long> projectIds,
                                                            List<String> issueTypeIds)

Description copied from interface: ArchivedIssueSearchService

For the projects specified by projectIds, finds archived issues that are of the types given by issueTypIds. TO be removed after implementation of searching/browsing archived projects by using its API instead

Specified by:

getArchivedIssuesMatchingTypesInProjects in interface ArchivedIssueSearchService

Parameters:

projectIds - unique identifiers for the projects whose issues we'd like to inspect.

issueTypeIds - unique identifiers for the issue types that we're looking for instances of in the projects.

Returns:

the list of archived issues in the given projects that are of the types specified by issueTypeIds or an empty list if projectIds or issueTypeIds are empty.

validateSearch

public ArchivedIssueSearchService.ValidationResult validateSearch(ArchivedIssueSearchService.ArchiveSearchRequest request)

Description copied from interface: ArchivedIssueSearchService

Validate search request

Specified by:

validateSearch in interface ArchivedIssueSearchService

Parameters:

request - search request

Returns:

validation result

validateSearchOverrideSecurity

public ArchivedIssueSearchService.ValidationResult validateSearchOverrideSecurity(ArchivedIssueSearchService.ArchiveSearchRequest request)

Description copied from interface: ArchivedIssueSearchService

Validate search request not taking into account any security

As the method name implies, it bypasses the security restrictions that would normally be applied when performing a search. As such, it should only be used for administrative task.

Specified by:

validateSearchOverrideSecurity in interface ArchivedIssueSearchService

Parameters:

request - search request

Returns:

validation result

search

public java.util.stream.Stream<ArchivedIssue> search(ArchivedIssueSearchService.ValidationResult validationResult)

Description copied from interface: ArchivedIssueSearchService

Search for issues in archive using given criteria.

Specified by:

search in interface ArchivedIssueSearchService

Parameters:

validationResult - of search in service

Returns:

a stream of archived issues matching given query

count

public int count(ArchivedIssueSearchService.ValidationResult validationResult)

Description copied from interface: ArchivedIssueSearchService

Count number of issues in archive using given criteria.

For just checking if there are any archived issues, use ArchivedIssueSearchService.archivedProjectsOrIssuesExist().

Specified by:

count in interface ArchivedIssueSearchService

Parameters:

validationResult - of search in service

Returns:

a number of issues matching search criteria

archivedProjectsOrIssuesExist

public boolean archivedProjectsOrIssuesExist()

Specified by:

archivedProjectsOrIssuesExist in interface ArchivedIssueSearchService

Returns:

true if at least one project or issue is archived, false otherwise

parse

public static io.atlassian.fugue.Either<Long,String> parse(String projectKeyOrId)