fr.paris.lutece.plugins.childpages.business.portlet
Class ChildPagesPortlet

java.lang.Object
  extended by fr.paris.lutece.portal.business.portlet.Portlet
      extended by fr.paris.lutece.plugins.childpages.business.portlet.ChildPagesPortlet
All Implemented Interfaces:
fr.paris.lutece.portal.business.XmlContent

public class ChildPagesPortlet
extends fr.paris.lutece.portal.business.portlet.Portlet

This class represents business objects ChildPagesPortlet


Field Summary
static java.lang.String TAG_CHILD_PAGE
           
static java.lang.String TAG_CHILD_PAGE_DESCRIPTION
           
static java.lang.String TAG_CHILD_PAGE_ID
           
static java.lang.String TAG_CHILD_PAGE_IMAGE
           
static java.lang.String TAG_CHILD_PAGE_NAME
           
static java.lang.String TAG_CHILD_PAGES_PORTLET_LIST
           
 
Fields inherited from interface fr.paris.lutece.portal.business.XmlContent
TAG_CHILD_PAGES_LIST, TAG_CURRENT_PAGE_ID, TAG_DISPLAY_PORTLET_TITLE, TAG_MENU, TAG_MENU_INDEX, TAG_MENU_LIST, TAG_MODE, TAG_PAGE, TAG_PAGE_DESCRIPTION, TAG_PAGE_ID, TAG_PAGE_IMAGE, TAG_PAGE_LEVEL, TAG_PAGE_NAME, TAG_PARENT_PAGE_ID, TAG_PLUGIN_NAME, TAG_PORTLET, TAG_PORTLET_ID, TAG_PORTLET_NAME, TAG_SUBLEVEL_INDEX, TAG_SUBLEVEL_MENU, TAG_SUBLEVEL_MENU_LIST
 
Constructor Summary
ChildPagesPortlet()
          Sets the identifier of the portlet type to the value specified in the ChildPagesPortletHome class
 
Method Summary
 int getParentPageId()
          Returns the identifier of the parent page of the portlet
 java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the Child pages portlet without XML heading
 java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the ChildPage portlet with XML heading
 void remove()
          Removes the current instance of the ChildPage Portlet object
 void setParentPageId(int nParentPageId)
          Sets the parent page identifier of the portlet to the value specified in parameter
 void update()
          Updates the current instance of the ChildPage Portlet object
 
Methods inherited from class fr.paris.lutece.portal.business.portlet.Portlet
addPortletTags, copy, getAcceptAlias, getColumn, getDateUpdate, getDisplayPortletTitle, getHomeClassName, getId, getName, getOrder, getPageId, getPluginName, getPortletTypeId, getPortletTypeName, getStatus, getStyleId, getUrlCreation, getUrlUpdate, getXslFile, getXslParams, getXslSource, setAcceptAlias, setColumn, setDateUpdate, setDisplayPortletTitle, setHomeClassName, setId, setName, setOrder, setPageId, setPluginName, setPortletTypeId, setPortletTypeName, setStatus, setStyleId, setUrlCreation, setUrlUpdate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TAG_CHILD_PAGE

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

TAG_CHILD_PAGE_ID

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

TAG_CHILD_PAGE_NAME

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

TAG_CHILD_PAGE_DESCRIPTION

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

TAG_CHILD_PAGE_IMAGE

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

TAG_CHILD_PAGES_PORTLET_LIST

public static final java.lang.String TAG_CHILD_PAGES_PORTLET_LIST
See Also:
Constant Field Values
Constructor Detail

ChildPagesPortlet

public ChildPagesPortlet()
Sets the identifier of the portlet type to the value specified in the ChildPagesPortletHome class

Method Detail

setParentPageId

public void setParentPageId(int nParentPageId)
Sets the parent page identifier of the portlet to the value specified in parameter

Parameters:
nParentPageId - new parent page identifier

getParentPageId

public int getParentPageId()
Returns the identifier of the parent page of the portlet

Returns:
the parent page identifier

getXml

public java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
Returns the Xml code of the Child pages portlet without XML heading

Parameters:
request - The HTTP Servlet Request
Returns:
the Xml code of the child pages portlet content

getXmlDocument

public java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
Returns the Xml code of the ChildPage portlet with XML heading

Parameters:
request - The HTTP Servlet Request
Returns:
the Xml code of the ChildPage portlet

update

public void update()
Updates the current instance of the ChildPage Portlet object


remove

public void remove()
Removes the current instance of the ChildPage Portlet object

Overrides:
remove in class fr.paris.lutece.portal.business.portlet.Portlet


Copyright © 2007 Mairie de Paris. All Rights Reserved.