fr.paris.lutece.portal.business

Interface XmlContent

All Known Implementing Classes:

AliasPortlet, Portlet, PortletHtmlContent, PortletImpl

public interface XmlContent

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_CHILD_PAGES_LIST
static String	TAG_CURRENT_PAGE_ID
static String	TAG_DISPLAY_ON_LARGE_DEVICE
static String	TAG_DISPLAY_ON_NORMAL_DEVICE
static String	TAG_DISPLAY_ON_SMALL_DEVICE
static String	TAG_DISPLAY_ON_XLARGE_DEVICE
static String	TAG_DISPLAY_PORTLET_TITLE
static String	TAG_MENU
static String	TAG_MENU_INDEX
static String	TAG_MENU_LIST
static String	TAG_MODE
static String	TAG_PAGE
static String	TAG_PAGE_DESCRIPTION
static String	TAG_PAGE_ID
static String	TAG_PAGE_IMAGE
static String	TAG_PAGE_LEVEL
static String	TAG_PAGE_NAME
static String	TAG_PARENT_PAGE_ID
static String	TAG_PLUGIN_NAME
static String	TAG_PORTLET
static String	TAG_PORTLET_ID
static String	TAG_PORTLET_NAME
static String	TAG_SUBLEVEL_INDEX
static String	TAG_SUBLEVEL_MENU
static String	TAG_SUBLEVEL_MENU_LIST

Method Summary

Methods

Modifier and Type	Method and Description
String	getXml(javax.servlet.http.HttpServletRequest request) This method should return the body of an Xml document providing the content
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 String TAG_PLUGIN_NAME

See Also:

Constant Field Values

TAG_MODE

static final String TAG_MODE

See Also:

Constant Field Values

TAG_MENU_LIST

static final String TAG_MENU_LIST

See Also:

Constant Field Values

TAG_MENU

static final String TAG_MENU

See Also:

Constant Field Values

TAG_SUBLEVEL_MENU_LIST

static final String TAG_SUBLEVEL_MENU_LIST

See Also:

Constant Field Values

TAG_SUBLEVEL_MENU

static final String TAG_SUBLEVEL_MENU

See Also:

Constant Field Values

TAG_MENU_INDEX

static final String TAG_MENU_INDEX

See Also:

Constant Field Values

TAG_SUBLEVEL_INDEX

static final String TAG_SUBLEVEL_INDEX

See Also:

Constant Field Values

TAG_PORTLET

static final String TAG_PORTLET

See Also:

Constant Field Values

TAG_PORTLET_ID

static final String TAG_PORTLET_ID

See Also:

Constant Field Values

TAG_PORTLET_NAME

static final String TAG_PORTLET_NAME

See Also:

Constant Field Values

TAG_DISPLAY_PORTLET_TITLE

static final String TAG_DISPLAY_PORTLET_TITLE

See Also:

Constant Field Values

TAG_DISPLAY_ON_SMALL_DEVICE

static final String TAG_DISPLAY_ON_SMALL_DEVICE

See Also:

Constant Field Values

TAG_DISPLAY_ON_NORMAL_DEVICE

static final String TAG_DISPLAY_ON_NORMAL_DEVICE

See Also:

Constant Field Values

TAG_DISPLAY_ON_LARGE_DEVICE

static final String TAG_DISPLAY_ON_LARGE_DEVICE

See Also:

Constant Field Values

TAG_DISPLAY_ON_XLARGE_DEVICE

static final String TAG_DISPLAY_ON_XLARGE_DEVICE

See Also:

Constant Field Values

TAG_PAGE

static final String TAG_PAGE

See Also:

Constant Field Values

TAG_PAGE_ID

static final String TAG_PAGE_ID

See Also:

Constant Field Values

TAG_PAGE_NAME

static final String TAG_PAGE_NAME

See Also:

Constant Field Values

TAG_PAGE_DESCRIPTION

static final String TAG_PAGE_DESCRIPTION

See Also:

Constant Field Values

TAG_PAGE_IMAGE

static final String TAG_PAGE_IMAGE

See Also:

Constant Field Values

TAG_PAGE_LEVEL

static final String TAG_PAGE_LEVEL

See Also:

Constant Field Values

TAG_CHILD_PAGES_LIST

static final String TAG_CHILD_PAGES_LIST

See Also:

Constant Field Values

TAG_CURRENT_PAGE_ID

static final String TAG_CURRENT_PAGE_ID

See Also:

Constant Field Values

TAG_PARENT_PAGE_ID

static final String TAG_PARENT_PAGE_ID

See Also:

Constant Field Values

Method Detail

getXml

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

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