Package org.opencms.xml.xml2json.document

Interface I_CmsJsonDocument

All Known Implementing Classes:

CmsJsonDocumentContainerPage, CmsJsonDocumentEmbeddedXmlContent, CmsJsonDocumentFolder, CmsJsonDocumentList, CmsJsonDocumentResource, CmsJsonDocumentXmlContent

public interface I_CmsJsonDocument

Interface representing a JSON document.

Method Summary

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

Method Details

getJson

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

Returns the JSON document.

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

Exception - if something else goes wrong