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

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

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

This class represents business objects ArticlesList Portlet


Field Summary
 
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
DocumentListPortlet()
          Sets the identifier of the portlet type to the value specified in the ArticlesListPortletHome class
 
Method Summary
 int getDocumentId()
          Returns the nDocumentId
 int getDocumentOrder()
          Returns the order of the dosument
 java.lang.String getDocumentTypeCode()
          Returns the identifier of the parent page of the portlet
 int getPortletId()
          Returns the nPortletId
 int getStatus()
          Returns the Status
 java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the Document List portlet without XML heading
 java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the Articles List portlet with XML heading
 void remove()
          Removes the current instance of the Articles List Portlet object
 void setDocumentId(int nDocumentId)
          Sets the DocumentId
 void setDocumentOrder(int nDocumentOrder)
          Sets order
 void setDocumentTypeCode(java.lang.String strDocumentTypeCode)
          Sets the parent page identifier of the portlet to the value specified in parameter
 void setPortletId(int nPortletId)
          Sets the IdPortlet
 void setStatus(int nStatus)
          Sets the Status
 void update()
          Updates the current instance of the Articles List 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, getStyleId, getUrlCreation, getUrlUpdate, getXslFile, getXslParams, getXslSource, setAcceptAlias, setColumn, setDateUpdate, setDisplayPortletTitle, setHomeClassName, setId, setName, setOrder, setPageId, setPluginName, setPortletTypeId, setPortletTypeName, setStyleId, setUrlCreation, setUrlUpdate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentListPortlet

public DocumentListPortlet()
Sets the identifier of the portlet type to the value specified in the ArticlesListPortletHome class

Method Detail

getXml

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

Parameters:
request - The HTTP Servlet request
Returns:
the Xml code of the Document List portlet content

getXmlDocument

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

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

update

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


remove

public void remove()
Removes the current instance of the Articles List Portlet 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

getDocumentId

public int getDocumentId()
Returns the nDocumentId

Returns:
The DocumentId

setDocumentId

public void setDocumentId(int nDocumentId)
Sets the DocumentId

Parameters:
nDocumentId - The nDocumentId

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

setDocumentOrder

public void setDocumentOrder(int nDocumentOrder)
Sets order

Parameters:
nDocumentOrder - the order

getDocumentOrder

public int getDocumentOrder()
Returns the order of the dosument

Returns:
the order or document

getStatus

public int getStatus()
Returns the Status

Overrides:
getStatus in class fr.paris.lutece.portal.business.portlet.Portlet
Returns:
The Status

setStatus

public void setStatus(int nStatus)
Sets the Status

Overrides:
setStatus in class fr.paris.lutece.portal.business.portlet.Portlet
Parameters:
nStatus - The Status


Copyright © 2007 Mairie de Paris. All Rights Reserved.