Package org.opencms.xml.xml2json.document

Class CmsJsonDocumentContainerPage

java.lang.Object

org.opencms.xml.xml2json.document.A_CmsJsonDocument

org.opencms.xml.xml2json.document.CmsJsonDocumentResource

org.opencms.xml.xml2json.document.CmsJsonDocumentXmlContent

org.opencms.xml.xml2json.document.CmsJsonDocumentContainerPage

All Implemented Interfaces:

I_CmsJsonDocument

public class CmsJsonDocumentContainerPage
extends CmsJsonDocumentXmlContent

Class representing a JSON document for a container page.

Field Summary

Fields inherited from class org.opencms.xml.xml2json.document.CmsJsonDocumentXmlContent

m_embedLinkedModelgroup, m_throwException, m_xmlContent

Fields inherited from class org.opencms.xml.xml2json.document.CmsJsonDocumentResource

m_helper, m_resource

Fields inherited from class org.opencms.xml.xml2json.document.A_CmsJsonDocument

FIELD_LINKED_CONTENTS, m_context, m_json, m_jsonRequest

Constructor Summary

Constructors

Constructor	Description
CmsJsonDocumentContainerPage(CmsJsonRequest jsonRequest, CmsXmlContent xmlContent)	Creates a new container page JSON document.
CmsJsonDocumentContainerPage(CmsJsonRequest jsonRequest, CmsXmlContent xmlContent, boolean embedLinkedModelgroups)	Creates a new container page JSON document.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getJson()	Returns the JSON document.

Methods inherited from class org.opencms.xml.xml2json.document.CmsJsonDocumentXmlContent

insertJsonLinkedContent, insertJsonLinkedContents, insertJsonWrapper, isLocaleAllRequest, isLocalePathRequest, isLocaleRequest, isShowFallbackLocaleRequest, isShowLinkedContentsRequest, isShowWrapperRequest

Methods inherited from class org.opencms.xml.xml2json.document.CmsJsonDocumentResource

insertJsonResource, insertJsonResourceAttributes, insertJsonResourceFile, insertJsonResourceParams, insertJsonResourcePathAndLink, insertJsonResourceProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsJsonDocumentContainerPage

public CmsJsonDocumentContainerPage(CmsJsonRequest jsonRequest,
                                    CmsXmlContent xmlContent)
                             throws java.lang.Exception

Creates a new container page JSON document.

Parameters:

jsonRequest - the JSON request

xmlContent - the XML content

Throws:

java.lang.Exception - if something goes wrong

CmsJsonDocumentContainerPage

public CmsJsonDocumentContainerPage(CmsJsonRequest jsonRequest,
                                    CmsXmlContent xmlContent,
                                    boolean embedLinkedModelgroups)
                             throws java.lang.Exception

Creates a new container page JSON document.

Parameters:

jsonRequest - the JSON request

xmlContent - the XML content

embedLinkedModelgroups - whether to embedLinkedContents

Throws:

java.lang.Exception - if something goes wrong

Method Detail

getJson

public java.lang.Object getJson()
                         throws JSONException,
                                CmsException,
                                CmsJsonHandlerException,
                                CmsJsonHandlerXmlContent.PathNotFoundException,
                                java.lang.Exception

Description copied from interface: I_CmsJsonDocument

Returns the JSON document.

Specified by:

getJson in interface I_CmsJsonDocument

Overrides:

getJson in class CmsJsonDocumentXmlContent

Returns:

the JSON document

Throws:

JSONException - if rendering the JSON document fails

CmsException - if reading a resource or evaluating a SOLR search fails

CmsJsonHandlerException - if the request is not valid according to the specification

CmsJsonHandlerXmlContent.PathNotFoundException - if the selected path does not exist

java.lang.Exception - if something else goes wrong

See Also:

CmsJsonDocumentResource.getJson()