fr.paris.lutece.portal.business.portlet
Interface IPortletDAO

All Known Implementing Classes:
PortletDAO

public interface IPortletDAO

IPortletDAO Interface


Method Summary
 void delete(int nPortletId)
          Delete a record from the table and its alias
 boolean hasAlias(int nPortletId)
          Indicates if the portlet has alias in the database or not.
 void insert(Portlet portlet)
          Insert a new record in the table.
 Portlet load(int nPortletId)
          Load the data of a portlet from the database
 int newPrimaryKey()
          Returns a new primary key which will be used to add a new portlet
 java.util.Collection selectPortletListByStyle(int nStyleId)
          Returns the list of the portlets associated to the style
 java.util.List<Portlet> selectPortletsByType(java.lang.String strPortletTypeId)
          Returns a list of portlets according to the selected type
 java.util.Collection selectPortletsListbyName(java.lang.String strPortletName)
          Returns the list of portlets in a distinct name
 PortletType selectPortletType(java.lang.String strPortletTypeId)
          Returns the instance of the PortletType whose identifier is specified in parameter
 ReferenceList selectStylesList(java.lang.String strPortletTypeId)
          Returns all the styles corresponding to a portlet type
 StyleSheet selectXslFile(int nPortletId, int nIdMode)
          Returns the stylesheet of the portlet according to the mode
 void store(Portlet portlet)
          Update the record in the table
 void updateStatus(Portlet portlet, int nStatus)
          Update the portlet status : 0 for activated - 1 for suspended
 

Method Detail

insert

void insert(Portlet portlet)
Insert a new record in the table. NB : The portlet identifier will already been obtained by the portlet girl

Parameters:
portlet - the portlet to insert in the database

delete

void delete(int nPortletId)
Delete a record from the table and its alias

Parameters:
nPortletId - the identifier of the portlet to be deleted

load

Portlet load(int nPortletId)
Load the data of a portlet from the database

Parameters:
nPortletId - the portlet identifier
Returns:
the object Portlet initialized with the data of the database

store

void store(Portlet portlet)
Update the record in the table

Parameters:
portlet - the portlet reference

newPrimaryKey

int newPrimaryKey()
Returns a new primary key which will be used to add a new portlet

Returns:
The new key.

updateStatus

void updateStatus(Portlet portlet,
                  int nStatus)
Update the portlet status : 0 for activated - 1 for suspended

Parameters:
portlet - the portlet to upadte in the database
nStatus - the status to update

selectXslFile

StyleSheet selectXslFile(int nPortletId,
                         int nIdMode)
Returns the stylesheet of the portlet according to the mode

Parameters:
nPortletId - the identifier of the portlet
nIdMode - the selected mode
Returns:
the stylesheet

selectPortletsListbyName

java.util.Collection selectPortletsListbyName(java.lang.String strPortletName)
Returns the list of portlets in a distinct name

Parameters:
strPortletName - the name of portlet
Returns:
the list in form of Collection
Throws:
AppException

selectPortletsByType

java.util.List<Portlet> selectPortletsByType(java.lang.String strPortletTypeId)
Returns a list of portlets according to the selected type

Parameters:
strPortletTypeId - the portlet type
Returns:
the portlets in form of Collection

selectStylesList

ReferenceList selectStylesList(java.lang.String strPortletTypeId)
Returns all the styles corresponding to a portlet type

Parameters:
strPortletTypeId - the identifier of the portlet type
Returns:
the list of styles in form of ReferenceList

hasAlias

boolean hasAlias(int nPortletId)
Indicates if the portlet has alias in the database or not.

Parameters:
nPortletId - the identifier of the portlet
Returns:
true if the portlet has some alias, false if not.

selectPortletType

PortletType selectPortletType(java.lang.String strPortletTypeId)
Returns the instance of the PortletType whose identifier is specified in parameter

Parameters:
strPortletTypeId - the identifier of the portlet type
Returns:
the instance of the portlet type

selectPortletListByStyle

java.util.Collection selectPortletListByStyle(int nStyleId)
Returns the list of the portlets associated to the style

Parameters:
nStyleId - the identifier of the style
Returns:
the list of the portlets in form of a Collection of Portlets objects


Copyright © 2007 Mairie de Paris. All Rights Reserved.