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     */
020    package org.sonar.wsclient.issue;
021    
022    import javax.annotation.CheckForNull;
023    
024    import java.util.Date;
025    import java.util.List;
026    import java.util.Map;
027    
028    /**
029     * @since 3.6
030     */
031    public interface Issue {
032    
033      /**
034       * Unique key
035       */
036      String key();
037    
038      String componentKey();
039    
040      Long componentId();
041    
042      String projectKey();
043    
044      String ruleKey();
045    
046      String severity();
047    
048      @CheckForNull
049      String message();
050    
051      @CheckForNull
052      Integer line();
053    
054      @CheckForNull
055      Double effortToFix();
056    
057      @CheckForNull
058      String debt();
059    
060      String status();
061    
062      /**
063       * The resolution type. Null if the issue is not resolved.
064       */
065      @CheckForNull
066      String resolution();
067    
068      @CheckForNull
069      String reporter();
070    
071      /**
072       * Login of assignee. Null if issue is not assigned.
073       */
074      @CheckForNull
075      String assignee();
076    
077      /**
078       * SCM account
079       */
080      @CheckForNull
081      String author();
082    
083      @CheckForNull
084      String actionPlan();
085    
086      Date creationDate();
087    
088      Date updateDate();
089    
090      @CheckForNull
091      Date closeDate();
092    
093      @CheckForNull
094      String attribute(String key);
095    
096      Map<String, String> attributes();
097    
098      /**
099       * Non-null list of comments
100       */
101      List<IssueComment> comments();
102    }