Package com.atlassian.greenhopper.service.issue

Interface RapidViewIssueService

All Known Implementing Classes:
RapidViewIssueServiceImpl
@ExperimentalApi public interface RapidViewIssueService
Service which provides method to access RapidViewIssues.

Before each operation validation is performed and its result is returned in ServiceOutcome. During validation, parameters and user's permissions are checked. User param with null value is treated as non-logged user.

Since:
6.7

  • Method Details

    • getIssuesForRapidView

      ServiceOutcome<Page<RapidViewIssue>> getIssuesForRapidView(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull RapidView rapidView, @Nonnull PageRequest request, @Nullable com.atlassian.query.Query query)
      Returns a page with issues that belong to given rapid view. The rapid view contains issues which match rapid view's filter and state of the issue corresponds to states of one of the rapid view column. Issue which have issue type "epic" are not returned from "scrum" board. Issues are returned ordered by theirs rank. Query order has higher priority than default rank.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      rapidView - the rapidView which contains issues.
      request - information about the desired number of results and their offset.
      query - the jql query which limits the result only to these issues which fulfil its constraints.
      Returns:
      a page of found issues or error if operation failed.

    • getIssuesForBacklog

      ServiceOutcome<Page<RapidViewIssue>> getIssuesForBacklog(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull RapidView rapidView, @Nonnull PageRequest request, @Nullable com.atlassian.query.Query query)
      Returns a page with issues that belong to backlog of given rapid view. The backlog contains all issues which are not done and are not assigned to a future or active sprint. Issues are returned ordered by theirs rank. Query order has higher priority than default rank.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      rapidView - the rapidView which contains issues.
      request - information about the desired number of results and their offset.
      query - the jql query which limits the result only to these issues which fulfil its constraints.
      Returns:
      a page of found issues or error if operation failed.

    • getIssuesForSprint

      ServiceOutcome<Page<RapidViewIssue>> getIssuesForSprint(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull Sprint sprint, @Nonnull PageRequest request, @Nullable com.atlassian.query.Query query)
      Returns a page with issues that belong to given sprint. Issues are returned ordered by theirs rank. Query order has higher priority than default rank.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      sprint - the sprint which contains issues.
      request - information about the desired number of results and their offset.
      query - the jql query which limits the result only to these issues which fulfil its constraints.
      Returns:
      a page of found issues or error if operation failed.

    • getIssuesForSprintInBoardContext

      ServiceOutcome<Page<RapidViewIssue>> getIssuesForSprintInBoardContext(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull RapidView rapidView, @Nonnull Sprint sprint, @Nonnull PageRequest request, @Nullable com.atlassian.query.Query query)
      Returns a page with issues that belong to given sprint in given rapid view. Issues are returned ordered by theirs rank. Query order has higher priority than default rank.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      rapidView - the rapidView in which context search will be performed.
      sprint - the sprint which contains issues.
      request - information about the desired number of results and their offset.
      query - the jql query which limits the result only to these issues which fulfil its constraints.
      Returns:
      a page of found issues or error if operation failed.

    • getIssuesForEpic

      ServiceOutcome<Page<RapidViewIssue>> getIssuesForEpic(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull RapidView rapidView, @Nonnull Epic epic, @Nonnull PageRequest request, @Nullable com.atlassian.query.Query query)
      Returns a page with issues that belong to the given epic in given rapid view. Issues are returned ordered by theirs rank. Query order has higher priority than default rank.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      rapidView - the rapidView in which context search will be performed.
      epic - the epic which contains issues.
      request - information about the desired number of results and their offset.
      query - the jql query which limits the result only to these issues which fulfil its constraints.
      Returns:
      a page of found issues or error if operation failed.

    • getIssuesWithoutEpic

      ServiceOutcome<Page<RapidViewIssue>> getIssuesWithoutEpic(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull RapidView rapidView, @Nonnull PageRequest request, @Nullable com.atlassian.query.Query query)
      Returns a page with issues that do not belong to any epic in given rapid view. Issues are returned ordered by theirs rank. Query order has higher priority than default rank.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      rapidView - the rapidView in which context search will be performed.
      request - information about the desired number of results and their offset.
      query - the jql query which limits the result only to these issues which fulfil its constraints.
      Returns:
      a page of found issues or error if operation failed.

    • getIssuesForEpic

      ServiceOutcome<Page<RapidViewIssue>> getIssuesForEpic(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull Epic epic, @Nonnull PageRequest request, @Nullable com.atlassian.query.Query query)
      Returns a page with issues that belong to the given epic. Issues are returned ordered by theirs rank. Query order has higher priority than default rank.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      epic - the epic which contains issues.
      request - information about the desired number of results and their offset.
      query - the jql query which limits the result only to these issues which fulfil its constraints.
      Returns:
      a page of found issues or error if operation failed.

    • getIssuesWithoutEpic

      ServiceOutcome<Page<RapidViewIssue>> getIssuesWithoutEpic(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull PageRequest request, @Nullable com.atlassian.query.Query query)
      Returns a page with issues that do not belong to any epic. Issues are returned ordered by theirs rank. Query order has higher priority than default rank.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      request - information about the desired number of results and their offset.
      query - the jql query which limits the result only to these issues which fulfil its constraints.
      Returns:
      a page of found issues or error if operation failed.

    • getIssueById

      ServiceOutcome<RapidViewIssue> getIssueById(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull Long issueId)
      Returns a single issue.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      issueId - the id of requested issue.
      Returns:
      either an issue or error if operation failed.

    • getIssueByKey

      ServiceOutcome<RapidViewIssue> getIssueByKey(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull com.atlassian.jira.issue.IssueKey key)
      Returns a single issue.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      key - the key of requested issue.
      Returns:
      either an issue or error if operation failed.

    • getIssueEstimationForBoard

      ServiceOutcome<FieldValue> getIssueEstimationForBoard(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull com.atlassian.jira.issue.Issue issue, @Nonnull RapidView rapidView)
      Returns the issue estimation for board.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      issue - the issue that is going to be estimated.
      rapidView - the rapid view that is required to determine which field is used for estimation.
      Returns:
      a service result which is either valid or contains error messages.

    • estimateIssueForBoard

      ServiceOutcome<FieldValue> estimateIssueForBoard(@Nullable com.atlassian.jira.user.ApplicationUser user, @Nonnull com.atlassian.jira.issue.Issue issue, @Nonnull RapidView rapidView, @Nonnull String value)
      Estimate the issue. The format of the field depends on the field used for board estimation. Estimation config can be check by RapidViewConfigService.getEstimationConfig(com.atlassian.jira.user.ApplicationUser, com.atlassian.greenhopper.model.rapid.RapidView) method.
      Parameters:
      user - the user who is performing operation and whose permissions are checked. Null means anonymous access.
      issue - the issue that is going to be estimated.
      rapidView - the rapid view that is required to determine which field is used for estimation.
      value - the of new estimation.
      Returns:
      a service result which is either valid or contains error messages.