001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.xml.xml2json;
029
030import org.opencms.file.CmsResource;
031
032import javax.servlet.http.HttpServletResponse;
033
034/**
035 * Result of rendering JSON.
036 *
037 * Can be either a JSON value together with a response status, or a resource that should be loaded for the current request.
038 */
039public class CmsJsonResult {
040
041    /** The JSON result data. */
042    private Object m_json;
043
044    /** The HTTP status. */
045    private int m_status = HttpServletResponse.SC_OK;
046
047    /** The next resource to be loaded. */
048    private CmsResource m_nextResource;
049
050    /**
051     * Creates a result which indicates that a different resource should be loaded instead.
052     *
053     * @param resource the resource
054     */
055    public CmsJsonResult(CmsResource resource) {
056
057        m_nextResource = resource;
058    }
059
060    /**
061     * Creates a new instance.
062     *
063     * @param json the JSON data
064     * @param status the result
065     */
066    public CmsJsonResult(Object json, int status) {
067
068        m_json = json;
069        m_status = status;
070    }
071
072    /**
073     * Gets the JSON data.
074     * @return the JSON data
075     */
076    public Object getJson() {
077
078        return m_json;
079
080    }
081
082    /**
083     * Gets the next resource which should be loaded.
084     *
085     * @return the resource which should be loaded
086     */
087    public CmsResource getNextResource() {
088
089        return m_nextResource;
090    }
091
092    /**
093     * Gets the HTTP status code to set.
094     *
095     * @return the HTTP status
096     */
097    public int getStatus() {
098
099        return m_status;
100    }
101
102}