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.document;
029
030import org.opencms.json.JSONException;
031import org.opencms.main.CmsException;
032import org.opencms.xml.xml2json.handler.CmsJsonHandlerException;
033import org.opencms.xml.xml2json.handler.CmsJsonHandlerXmlContent.PathNotFoundException;
034
035/**
036 * Interface representing a JSON document.<p>
037 */
038public interface I_CmsJsonDocument {
039
040    /**
041     * Returns the JSON document.<p>
042     *
043     * @return the JSON document
044     * @throws JSONException if rendering the JSON document fails
045     * @throws CmsException if reading a resource or evaluating a SOLR search fails
046     * @throws CmsJsonHandlerException if the request is not valid according to the specification
047     * @throws PathNotFoundException if the selected path does not exist
048     * @throws Exception if something else goes wrong
049     */
050    public Object getJson()
051    throws JSONException, CmsException, CmsJsonHandlerException, PathNotFoundException, Exception;
052}