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     */
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      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      String status();
056    
057      /**
058       * The resolution type. Null if the issue is not resolved.
059       */
060      @CheckForNull
061      String resolution();
062    
063      @CheckForNull
064      String reporter();
065    
066      /**
067       * Login of assignee. Null if issue is not assigned.
068       */
069      @CheckForNull
070      String assignee();
071    
072      /**
073       * SCM account
074       */
075      @CheckForNull
076      String author();
077    
078      @CheckForNull
079      String actionPlan();
080    
081      Date creationDate();
082    
083      Date updateDate();
084    
085      @CheckForNull
086      Date closeDate();
087    
088      @CheckForNull
089      String attribute(String key);
090    
091      Map<String, String> attributes();
092    
093      /**
094       * Non-null list of comments
095       */
096      List<IssueComment> comments();
097    }