org.sonar.api.issue.RubyIssueService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation
There is a newer version: 5.1
/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api.issue;

import org.sonar.api.ServerComponent;

import java.util.Map;

/**
 * Facade for JRuby on Rails extensions to request issues.
 * 
 * Reference from Ruby code : Api.issues
 * 
 *
 * @since 3.6
 */
public interface RubyIssueService extends ServerComponent {

  /**
   * Search for an issue by its key.
   * 
   * Ruby example: result = Api.issues.find('ABCDE-12345')
   */
  IssueQueryResult find(String issueKey);

  /**
   * Search for issues.
   * 

   * Ruby example: Api.issues.find({'statuses' => ['OPEN', 'RESOLVED'], 'assignees' => 'john,carla')}
   * 

   * Keys of parameters must be Ruby strings but not symbols. Multi-value parameters can be arrays (['OPEN', 'RESOLVED']) or
   * comma-separated list of strings ('OPEN,RESOLVED').
   * 

   * Optional parameters are:
   * 

   *   'issues': list of issue keys
   *   'severities': list of severity to match. See constants in {@link org.sonar.api.rule.Severity}
   *   'statuses': list of status to match. See constants in {@link Issue}
   *   'resolutions': list of resolutions to match. See constants in {@link Issue}
   *   'resolved': true to match only resolved issues, false to match only unresolved issues. By default no filtering is done.
   *   'components': list of component keys to match, for example 'org.apache.struts:struts:org.apache.struts.Action'
   *   'componentRoots': list of keys of root components. All the issues related to descendants of these roots are returned.
   *   'rules': list of keys of rules to match. Format is <repository>:<rule>, for example 'squid:AvoidCycles'
   *   'actionPlans': list of keys of the action plans to match. Note that plan names are not accepted.
   *   'planned': true to get only issues associated to an action plan, false to get only non associated issues. By default no filtering is done.
   *   'reporters': list of reporter logins. Note that reporters are defined only on "manual" issues.
   *   'assignees': list of assignee logins.
   *   'assigned': true to get only assigned issues, false to get only not assigned issues. By default no filtering is done.
   *   'createdAfter': match all the issues created after the given date (strictly).
   *   Both date and datetime ISO formats are supported: 2013-05-18 or 2010-05-18T15:50:45+0100
   *   'createdAt': match all the issues created at the given date (require second precision).
   *   Both date and datetime ISO formats are supported: 2013-05-18 or 2010-05-18T15:50:45+0100
   *   'createdBefore': match all the issues created before the given date (exclusive).
   *   Both date and datetime ISO formats are supported: 2013-05-18 or 2010-05-18T15:50:45+0100
   *   'pageSize': maximum number of results per page. Default is {@link org.sonar.api.issue.IssueQuery#DEFAULT_PAGE_SIZE},
   *   except when the parameter 'components' is set. In this case there's no limit by default (all results in the same page).
   *   'pageIndex': index of the selected page. Default is 1.
   *   'sort': field to sort on. See supported values in {@link IssueQuery}
   *   'asc': ascending or descending sort? Value can be a boolean or strings 'true'/'false'
   * 
   */
  IssueQueryResult find(Map parameters);

}