fr.paris.lutece.plugins.document.business.portlet
Class DocumentPortlet

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

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

DocumentPortlet


Field Summary
static java.lang.String RESOURCE_ID
           
 
Fields inherited from class fr.paris.lutece.portal.business.portlet.Portlet
STATUS_PUBLISHED, STATUS_UNPUBLISHED
 
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
DocumentPortlet()
          Sets the identifier of the portlet type to the value specified in the DocumentPortletHome class
 
Method Summary
 java.lang.String getDocumentTypeCode()
          Returns the identifier of the parent page of the portlet
 int[] getIdCategory()
           
 int getPortletId()
          Returns the nPortletId
 java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the DocumentPortlet without XML heading
 java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the ADocumentPortlet with XML heading
 void remove()
          Removes the current instance of the DocumentPortlet object
 void setDocumentTypeCode(java.lang.String strDocumentTypeCode)
          Sets the parent page identifier of the portlet to the value specified in parameter
 void setIdCategory(int[] arrayIdCategory)
           
 void setPortletId(int nPortletId)
          Sets the IdPortlet
 void update()
          Updates the current instance of the DocumentPortlet 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

RESOURCE_ID

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

DocumentPortlet

public DocumentPortlet()
Sets the identifier of the portlet type to the value specified in the DocumentPortletHome class

Method Detail

getXml

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

Parameters:
request - The HTTP Servlet request
Returns:
the Xml code of the DocumentPortlvet content

getXmlDocument

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

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

update

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


remove

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

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

getPortletId

public int getPortletId()
Returns the nPortletId

Returns:
The nPortletId

setPortletId

public void setPortletId(int nPortletId)
Sets the IdPortlet

Parameters:
nPortletId - The nPortletId

setDocumentTypeCode

public void setDocumentTypeCode(java.lang.String strDocumentTypeCode)
Sets the parent page identifier of the portlet to the value specified in parameter

Parameters:
strDocumentTypeCode - the code

getDocumentTypeCode

public java.lang.String getDocumentTypeCode()
Returns the identifier of the parent page of the portlet

Returns:
the parent page identifier

getIdCategory

public int[] getIdCategory()
Returns:
the _nIdCategory

setIdCategory

public void setIdCategory(int[] arrayIdCategory)
Parameters:
arrayIdCategory - the _nIdCategory to set


Copyright © 2009 Mairie de Paris. All Rights Reserved.