Board.java

/**
 * jira-client - a simple JIRA REST client
 * Copyright (c) 2013 Bob Carroll (bob.carroll@alum.rit.edu)
 * <p>
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * <p>
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * <p>
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

package net.rcarz.jiraclient.agile;

import java.util.List;

import net.rcarz.jiraclient.Field;
import net.rcarz.jiraclient.JiraException;
import net.rcarz.jiraclient.RestClient;
import net.sf.json.JSONObject;

/**
 * Represents an Agile Board.
 *
 * @author pldupont
 */
public class Board extends AgileResource
{

    private String type;

    /**
     * Creates a Board from a JSON payload.
     *
     * @param restclient REST client instance
     * @param json JSON payload
     */
    protected Board(RestClient restclient,
                    JSONObject json)
        throws JiraException
    {
        super(restclient, json);
    }

    /**
     * Retrieves the given rapid view.
     *
     * @param restclient REST client instance
     * @param id Internal JIRA ID of the rapid view
     * @return a rapid view instance
     * @throws JiraException when the retrieval fails
     */
    public static Board get(RestClient restclient,
                            long id)
        throws JiraException
    {
        return AgileResource.get(restclient, Board.class, RESOURCE_URI + "board/" + id);
    }

    /**
     * Retrieves all boards visible to the session user.
     *
     * @param restclient REST client instance
     * @return a list of boards
     * @throws JiraException when the retrieval fails
     */
    public static List<Board> getAll(RestClient restclient)
        throws JiraException
    {
        return AgileResource.list(restclient, Board.class, RESOURCE_URI + "board");
    }

    @Override
    protected void deserialize(JSONObject json)
        throws JiraException
    {
        super.deserialize(json);
        type = Field.getString(json.get("type"));
    }

    /**
     * @return The board type.
     */
    public String getType()
    {
        return this.type;
    }

    /**
     * @return All sprints related to the current board.
     * @throws JiraException when the retrieval fails
     */
    public List<Sprint> getSprints()
        throws JiraException
    {
        return Sprint.getAll(getRestclient(), getId());
    }

    /**
     * @return All issues in the Board backlog.
     * @throws JiraException when the retrieval fails
     */
    public List<Issue> getBacklog()
        throws JiraException
    {
        return AgileResource.list(getRestclient(),
                                  Issue.class,
                                  RESOURCE_URI + "board/" + getId() + "/backlog",
                                  "issues");
    }

    /**
     * @return All issues without epic in the Board .
     * @throws JiraException when the retrieval fails
     */
    public List<Issue> getIssuesWithoutEpic()
        throws JiraException
    {
        return AgileResource.list(getRestclient(),
                                  Issue.class,
                                  RESOURCE_URI + "board/" + getId() + "/epic/none/issue",
                                  "issues");
    }

    /**
     * @return All issues in the Board .
     * @throws JiraException when the retrieval fails
     */
    public List<Issue> getIssues()
        throws JiraException
    {
        return AgileResource.list(getRestclient(), Issue.class, RESOURCE_URI + "board/" + getId() + "/issue", "issues");
    }

    /**
     * @return All epics associated to the Board.
     * @throws JiraException when the retrieval fails
     */
    public List<Epic> getEpics(final String fields)
        throws JiraException
    {
        return AgileResource.list(getRestclient(),
                                  Epic.class,
                                  RESOURCE_URI + "board/" + getId() + "/epic",
                                  "values",
                                  null,
                                  fields);
    }
}