001/* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2014 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * SonarQube is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * SonarQube is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public License 017 * along with this program; if not, write to the Free Software Foundation, 018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 019 */ 020package org.sonar.wsclient.issue; 021 022import javax.annotation.CheckForNull; 023 024import java.util.Date; 025import java.util.List; 026import java.util.Map; 027 028/** 029 * @since 3.6 030 */ 031public interface Issue { 032 033 /** 034 * Unique key 035 */ 036 String key(); 037 038 String componentKey(); 039 040 /** 041 * @deprecated since 4.4. Use {@link #componentKey()} instead 042 */ 043 @Deprecated 044 Long componentId(); 045 046 String projectKey(); 047 048 String ruleKey(); 049 050 String severity(); 051 052 @CheckForNull 053 String message(); 054 055 @CheckForNull 056 Integer line(); 057 058 @CheckForNull 059 String debt(); 060 061 String status(); 062 063 /** 064 * The resolution type. Null if the issue is not resolved. 065 */ 066 @CheckForNull 067 String resolution(); 068 069 @CheckForNull 070 String reporter(); 071 072 /** 073 * Login of assignee. Null if issue is not assigned. 074 */ 075 @CheckForNull 076 String assignee(); 077 078 /** 079 * SCM account 080 */ 081 @CheckForNull 082 String author(); 083 084 @CheckForNull 085 String actionPlan(); 086 087 Date creationDate(); 088 089 Date updateDate(); 090 091 @CheckForNull 092 Date closeDate(); 093 094 @CheckForNull 095 String attribute(String key); 096 097 Map<String, String> attributes(); 098 099 /** 100 * Non-null list of comments 101 */ 102 List<IssueComment> comments(); 103}