Package com.atlassian.jira.issue.archiving

Interface ArchivedIssueSearchService

All Known Implementing Classes:
DefaultArchivedIssueSearchService
@ExperimentalApi public interface ArchivedIssueSearchService
Class for searching archived issues in Jira
Since:
v8.1

  • Method Details

    • getArchivedIssuesMatchingTypesInProjects

      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. TO be removed after implementation of searching/browsing archived projects by using its API instead
      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

      ArchivedIssueSearchService.ValidationResult validateSearch(ArchivedIssueSearchService.ArchiveSearchRequest request)
      Validate search request
      Parameters:
      request - search request
      Returns:
      validation result

    • validateSearchOverrideSecurity

      ArchivedIssueSearchService.ValidationResult validateSearchOverrideSecurity(ArchivedIssueSearchService.ArchiveSearchRequest request)
      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.

      Parameters:
      request - search request
      Returns:
      validation result

    • search

      Stream<ArchivedIssue> search(ArchivedIssueSearchService.ValidationResult validationResult)
      Search for issues in archive using given criteria.
      Parameters:
      validationResult - of search in service
      Returns:
      a stream of archived issues matching given query

    • count

      int count(ArchivedIssueSearchService.ValidationResult validationResult)
      Count number of issues in archive using given criteria.

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

      Parameters:
      validationResult - of search in service
      Returns:
      a number of issues matching search criteria

    • archivedProjectsOrIssuesExist

      boolean archivedProjectsOrIssuesExist()
      Returns:
      true if at least one project or issue is archived, false otherwise
      Since:
      v8.16