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 org.sonar.wsclient.base.Paging;
023    import org.sonar.wsclient.component.Component;
024    import org.sonar.wsclient.rule.Rule;
025    import org.sonar.wsclient.user.User;
026    
027    import javax.annotation.CheckForNull;
028    
029    import java.util.Collection;
030    import java.util.List;
031    
032    /**
033     * @since 3.6
034     */
035    public interface Issues {
036      List<Issue> list();
037    
038      int size();
039    
040      Collection<Rule> rules();
041    
042      Rule rule(Issue issue);
043    
044      Collection<User> users();
045    
046      @CheckForNull
047      User user(String login);
048    
049      Collection<Component> components();
050    
051      @CheckForNull
052      Component component(Issue issue);
053    
054      @CheckForNull
055      Component componentById(long id);
056    
057      @CheckForNull
058      Component componentByKey(String key);
059    
060      Collection<Component> projects();
061    
062      @CheckForNull
063      Component project(Issue issue);
064    
065      Collection<ActionPlan> actionPlans();
066    
067      @CheckForNull
068      ActionPlan actionPlans(Issue issue);
069    
070      Paging paging();
071    
072      Boolean maxResultsReached();
073    
074    }