fr.paris.lutece.portal.business.portlet
Class AliasPortlet

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

public class AliasPortlet
extends Portlet

This class represents business objects AliasPortlet


Field Summary
 
Fields inherited from class fr.paris.lutece.portal.business.portlet.Portlet
FLAG_DISPLAY_ON_LARGE_DEVICE, FLAG_DISPLAY_ON_NORMAL_DEVICE, FLAG_DISPLAY_ON_SMALL_DEVICE, FLAG_DISPLAY_ON_XLARGE_DEVICE, STATUS_PUBLISHED, STATUS_UNPUBLISHED
 
Fields inherited from interface fr.paris.lutece.portal.business.XmlContent
TAG_CHILD_PAGES_LIST, TAG_CURRENT_PAGE_ID, TAG_DISPLAY_ON_LARGE_DEVICE, TAG_DISPLAY_ON_NORMAL_DEVICE, TAG_DISPLAY_ON_SMALL_DEVICE, TAG_DISPLAY_ON_XLARGE_DEVICE, 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
AliasPortlet()
          Sets the identifier of the portlet type to the value specified in the AliasPortletHome class
 
Method Summary
 int getAliasId()
          Returns the alias identifier of the portlet
 String getXml(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the Alias portlet without XML heading
 String getXmlDocument(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the Alias portlet with XML heading
 Map<String,String> getXslParams()
          Gets the XSl parameters of the alias portlet and returns them in form of a dictionnary
 void remove()
          Removes the current instance of the AliasPortlet object
 void setAliasId(int nAliasId)
          Sets the alias identifier of the portlet with the specified int value
 void update()
          Updates the current instance of the AliasPortlet object
 
Methods inherited from class fr.paris.lutece.portal.business.portlet.Portlet
addPortletTags, canBeCachedForAnonymousUsers, canBeCachedForConnectedUsers, copy, getAcceptAlias, getColumn, getDateUpdate, getDeviceDisplayFlags, getDisplayPortletTitle, getHomeClassName, getHtmlContent, getId, getName, getOrder, getPageId, getPluginName, getPortletTypeId, getPortletTypeName, getRole, getStatus, getStyleId, getUrlCreation, getUrlUpdate, getXslFile, getXslSource, hasDeviceDisplayFlag, isContentGeneratedByXmlAndXsl, setAcceptAlias, setColumn, setDateUpdate, setDeviceDisplayFlags, setDisplayPortletTitle, setHomeClassName, setId, setName, setOrder, setPageId, setPluginName, setPortletTypeId, setPortletTypeName, setRole, setStatus, setStyleId, setUrlCreation, setUrlUpdate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AliasPortlet

public AliasPortlet()
Sets the identifier of the portlet type to the value specified in the AliasPortletHome class

Method Detail

setAliasId

public void setAliasId(int nAliasId)
Sets the alias identifier of the portlet with the specified int value

Parameters:
nAliasId - the Alias identifier

getAliasId

public int getAliasId()
Returns the alias identifier of the portlet

Returns:
the Alias identifier

getXml

public String getXml(javax.servlet.http.HttpServletRequest request)
              throws SiteMessageException
Returns the Xml code of the Alias portlet without XML heading

Parameters:
request - The HTTP servlet request
Returns:
the Xml code of the Alias portlet content
Throws:
SiteMessageException - occurs when a site message need to be displayed

getXmlDocument

public String getXmlDocument(javax.servlet.http.HttpServletRequest request)
                      throws SiteMessageException
Returns the Xml code of the Alias portlet with XML heading

Parameters:
request - The HTTP Servlet request
Returns:
the Xml code of the Alias portlet
Throws:
SiteMessageException - occurs when a site message need to be displayed

getXslParams

public Map<String,String> getXslParams()
Gets the XSl parameters of the alias portlet and returns them in form of a dictionnary

Overrides:
getXslParams in class Portlet
Returns:
the Xsl params

update

public void update()
Updates the current instance of the AliasPortlet object


remove

public void remove()
Removes the current instance of the AliasPortlet object

Specified by:
remove in class Portlet


Copyright © 2014 Mairie de Paris. All Rights Reserved.