001/* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2013 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 String projectKey(); 041 042 String ruleKey(); 043 044 String severity(); 045 046 @CheckForNull 047 String message(); 048 049 @CheckForNull 050 Integer line(); 051 052 @CheckForNull 053 Double effortToFix(); 054 055 @CheckForNull 056 WorkDayDuration technicalDebt(); 057 058 String status(); 059 060 /** 061 * The resolution type. Null if the issue is not resolved. 062 */ 063 @CheckForNull 064 String resolution(); 065 066 @CheckForNull 067 String reporter(); 068 069 /** 070 * Login of assignee. Null if issue is not assigned. 071 */ 072 @CheckForNull 073 String assignee(); 074 075 /** 076 * SCM account 077 */ 078 @CheckForNull 079 String author(); 080 081 @CheckForNull 082 String actionPlan(); 083 084 Date creationDate(); 085 086 Date updateDate(); 087 088 @CheckForNull 089 Date closeDate(); 090 091 @CheckForNull 092 String attribute(String key); 093 094 Map<String, String> attributes(); 095 096 /** 097 * Non-null list of comments 098 */ 099 List<IssueComment> comments(); 100}