fr.paris.lutece.portal.business
Interface XmlContent

All Known Implementing Classes:
AliasPortlet, Portlet, PortletImpl

public interface XmlContent

This class represents the interface XmlContent which contains the common Xml tags


Field Summary
static java.lang.String TAG_CHILD_PAGES_LIST
           
static java.lang.String TAG_CURRENT_PAGE_ID
           
static java.lang.String TAG_DISPLAY_ON_LARGE_DEVICE
           
static java.lang.String TAG_DISPLAY_ON_NORMAL_DEVICE
           
static java.lang.String TAG_DISPLAY_ON_SMALL_DEVICE
           
static java.lang.String TAG_DISPLAY_ON_XLARGE_DEVICE
           
static java.lang.String TAG_DISPLAY_PORTLET_TITLE
           
static java.lang.String TAG_MENU
           
static java.lang.String TAG_MENU_INDEX
           
static java.lang.String TAG_MENU_LIST
           
static java.lang.String TAG_MODE
           
static java.lang.String TAG_PAGE
           
static java.lang.String TAG_PAGE_DESCRIPTION
           
static java.lang.String TAG_PAGE_ID
           
static java.lang.String TAG_PAGE_IMAGE
           
static java.lang.String TAG_PAGE_LEVEL
           
static java.lang.String TAG_PAGE_NAME
           
static java.lang.String TAG_PARENT_PAGE_ID
           
static java.lang.String TAG_PLUGIN_NAME
           
static java.lang.String TAG_PORTLET
           
static java.lang.String TAG_PORTLET_ID
           
static java.lang.String TAG_PORTLET_NAME
           
static java.lang.String TAG_SUBLEVEL_INDEX
           
static java.lang.String TAG_SUBLEVEL_MENU
           
static java.lang.String TAG_SUBLEVEL_MENU_LIST
           
 
Method Summary
 java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
          This method should return the body of an Xml document providing the content
 java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
          This method should return the whole Xml document providing the content (including the header)
 

Field Detail

TAG_PLUGIN_NAME

static final java.lang.String TAG_PLUGIN_NAME
See Also:
Constant Field Values

TAG_MODE

static final java.lang.String TAG_MODE
See Also:
Constant Field Values

TAG_MENU_LIST

static final java.lang.String TAG_MENU_LIST
See Also:
Constant Field Values

TAG_MENU

static final java.lang.String TAG_MENU
See Also:
Constant Field Values

TAG_SUBLEVEL_MENU_LIST

static final java.lang.String TAG_SUBLEVEL_MENU_LIST
See Also:
Constant Field Values

TAG_SUBLEVEL_MENU

static final java.lang.String TAG_SUBLEVEL_MENU
See Also:
Constant Field Values

TAG_MENU_INDEX

static final java.lang.String TAG_MENU_INDEX
See Also:
Constant Field Values

TAG_SUBLEVEL_INDEX

static final java.lang.String TAG_SUBLEVEL_INDEX
See Also:
Constant Field Values

TAG_PORTLET

static final java.lang.String TAG_PORTLET
See Also:
Constant Field Values

TAG_PORTLET_ID

static final java.lang.String TAG_PORTLET_ID
See Also:
Constant Field Values

TAG_PORTLET_NAME

static final java.lang.String TAG_PORTLET_NAME
See Also:
Constant Field Values

TAG_DISPLAY_PORTLET_TITLE

static final java.lang.String TAG_DISPLAY_PORTLET_TITLE
See Also:
Constant Field Values

TAG_DISPLAY_ON_SMALL_DEVICE

static final java.lang.String TAG_DISPLAY_ON_SMALL_DEVICE
See Also:
Constant Field Values

TAG_DISPLAY_ON_NORMAL_DEVICE

static final java.lang.String TAG_DISPLAY_ON_NORMAL_DEVICE
See Also:
Constant Field Values

TAG_DISPLAY_ON_LARGE_DEVICE

static final java.lang.String TAG_DISPLAY_ON_LARGE_DEVICE
See Also:
Constant Field Values

TAG_DISPLAY_ON_XLARGE_DEVICE

static final java.lang.String TAG_DISPLAY_ON_XLARGE_DEVICE
See Also:
Constant Field Values

TAG_PAGE

static final java.lang.String TAG_PAGE
See Also:
Constant Field Values

TAG_PAGE_ID

static final java.lang.String TAG_PAGE_ID
See Also:
Constant Field Values

TAG_PAGE_NAME

static final java.lang.String TAG_PAGE_NAME
See Also:
Constant Field Values

TAG_PAGE_DESCRIPTION

static final java.lang.String TAG_PAGE_DESCRIPTION
See Also:
Constant Field Values

TAG_PAGE_IMAGE

static final java.lang.String TAG_PAGE_IMAGE
See Also:
Constant Field Values

TAG_PAGE_LEVEL

static final java.lang.String TAG_PAGE_LEVEL
See Also:
Constant Field Values

TAG_CHILD_PAGES_LIST

static final java.lang.String TAG_CHILD_PAGES_LIST
See Also:
Constant Field Values

TAG_CURRENT_PAGE_ID

static final java.lang.String TAG_CURRENT_PAGE_ID
See Also:
Constant Field Values

TAG_PARENT_PAGE_ID

static final java.lang.String TAG_PARENT_PAGE_ID
See Also:
Constant Field Values
Method Detail

getXml

java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
                        throws SiteMessageException
This method should return the body of an Xml document providing the content

Parameters:
request - The HTTP Servlet Request
Returns:
string The String
Throws:
SiteMessageException - occurs when a site message need to be displayed

getXmlDocument

java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
                                throws SiteMessageException
This method should return the whole Xml document providing the content (including the header)

Parameters:
request - The HTTP Servlet Request
Returns:
string The String
Throws:
SiteMessageException - occurs when a site message need to be displayed


Copyright © 2012 Mairie de Paris. All Rights Reserved.