fr.paris.lutece.portal.business.portlet

Class PortletDAO

java.lang.Object

fr.paris.lutece.portal.business.portlet.PortletDAO

All Implemented Interfaces:

IPortletDAO

public final class PortletDAO
extends Object
implements IPortletDAO

This class provides Data Access methods for Portlet objects

Constructor Summary

Constructors

Constructor and Description
PortletDAO()

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(int nPortletId) Delete a record from the table and its alias
List<Integer>	getUsedOrdersForColumns(int pageId, int columnId) Get list of used orders for a column
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
Portlet	loadLastModifiedPortlet() Load the last modified portlet
int	newPrimaryKey() Returns a new primary key which will be used to add a new portlet
Collection<Portlet>	selectAliasesForPortlet(int nPortletId) Returns the list of the alias portlets associated to the original portlet
Collection<PortletImpl>	selectPortletListByStyle(int nStyleId) Returns the list of the portlets associated to the style
Collection<Portlet>	selectPortletsByRole(String strRole) Gets a collection of portlets associated to a given role
List<Portlet>	selectPortletsByType(String strPortletTypeId) Returns a list of portlets according to the selected type
Collection<PortletImpl>	selectPortletsListbyName(String strPortletName) Returns the list of portlets in a distinct name
PortletType	selectPortletType(String strPortletTypeId) Returns the instance of the PortletType whose identifier is specified in parameter
ReferenceList	selectStylesList(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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletDAO

public PortletDAO()

Method Detail

insert

public void insert(Portlet portlet)

Insert a new record in the table. NB : The portlet identifier will already been obtained by the portlet girl

Specified by:

insert in interface IPortletDAO

Parameters:

portlet - the portlet to insert in the database

delete

public void delete(int nPortletId)

Delete a record from the table and its alias

Specified by:

delete in interface IPortletDAO

Parameters:

nPortletId - the identifier of the portlet to be deleted

load

public Portlet load(int nPortletId)

Load the data of a portlet from the database

Specified by:

load in interface IPortletDAO

Parameters:

nPortletId - the portlet identifier

Returns:

the object Portlet initialized with the data of the database

store

public void store(Portlet portlet)

Update the record in the table

Specified by:

store in interface IPortletDAO

Parameters:

portlet - the portlet reference

newPrimaryKey

public int newPrimaryKey()

Returns a new primary key which will be used to add a new portlet

Specified by:

newPrimaryKey in interface IPortletDAO

Returns:

The new key.

updateStatus

public void updateStatus(Portlet portlet,
                int nStatus)

Update the portlet status : 0 for activated - 1 for suspended

Specified by:

updateStatus in interface IPortletDAO

Parameters:

portlet - the portlet to upadte in the database

nStatus - the status to update

selectXslFile

public StyleSheet selectXslFile(int nPortletId,
                       int nIdMode)

Returns the stylesheet of the portlet according to the mode

Specified by:

selectXslFile in interface IPortletDAO

Parameters:

nPortletId - the identifier of the portlet

nIdMode - the selected mode

Returns:

the stylesheet

selectPortletsListbyName

public Collection<PortletImpl> selectPortletsListbyName(String strPortletName)

Returns the list of portlets in a distinct name

Specified by:

selectPortletsListbyName in interface IPortletDAO

Parameters:

strPortletName - the name of portlet

Returns:

the list in form of Collection

selectAliasesForPortlet

public Collection<Portlet> selectAliasesForPortlet(int nPortletId)

Returns the list of the alias portlets associated to the original portlet

Specified by:

selectAliasesForPortlet in interface IPortletDAO

Parameters:

nPortletId - the original portlet id

Returns:

the list of alais portlets.

selectPortletsByType

public List<Portlet> selectPortletsByType(String strPortletTypeId)

Returns a list of portlets according to the selected type

Specified by:

selectPortletsByType in interface IPortletDAO

Parameters:

strPortletTypeId - the portlet type

Returns:

the portlets in form of Collection

selectStylesList

public ReferenceList selectStylesList(String strPortletTypeId)

Returns all the styles corresponding to a portlet type

Specified by:

selectStylesList in interface IPortletDAO

Parameters:

strPortletTypeId - the identifier of the portlet type

Returns:

the list of styles in form of ReferenceList

hasAlias

public boolean hasAlias(int nPortletId)

Indicates if the portlet has alias in the database or not.

Specified by:

hasAlias in interface IPortletDAO

Parameters:

nPortletId - the identifier of the portlet

Returns:

true if the portlet has some alias, false if not.

selectPortletType

public PortletType selectPortletType(String strPortletTypeId)

Returns the instance of the PortletType whose identifier is specified in parameter

Specified by:

selectPortletType in interface IPortletDAO

Parameters:

strPortletTypeId - the identifier of the portlet type

Returns:

the instance of the portlet type

selectPortletListByStyle

public Collection<PortletImpl> selectPortletListByStyle(int nStyleId)

Returns the list of the portlets associated to the style

Specified by:

selectPortletListByStyle in interface IPortletDAO

Parameters:

nStyleId - the identifier of the style

Returns:

the list of the portlets in form of a Collection of Portlets objects

selectPortletsByRole

public Collection<Portlet> selectPortletsByRole(String strRole)

Gets a collection of portlets associated to a given role

Specified by:

selectPortletsByRole in interface IPortletDAO

Parameters:

strRole - The role

Returns:

The collection

loadLastModifiedPortlet

public Portlet loadLastModifiedPortlet()

Load the last modified portlet

Specified by:

loadLastModifiedPortlet in interface IPortletDAO

Returns:

the last modified Portlet

getUsedOrdersForColumns

public List<Integer> getUsedOrdersForColumns(int pageId,
                                    int columnId)

Get list of used orders for a column

Specified by:

getUsedOrdersForColumns in interface IPortletDAO

Parameters:

pageId - the page id

columnId - the column id

Returns:

list of orders used for this column