Package org.opencms.ui.favorites

Class CmsFavoriteDAO

java.lang.Object

org.opencms.ui.favorites.CmsFavoriteDAO

public class CmsFavoriteDAO
extends Object

Loads/saves favorites.

When loading favorites, the individual entries are validated by trying to read the resources/projects they reference. If this fails, the entries are discareded from the returned list.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDINFO_KEY	The additional info key under which the favorites for a user are saved.
static final String	BASE_KEY	The main key in the JSON object containing the favorites.

Constructor Summary

Constructors

Constructor	Description
CmsFavoriteDAO(CmsObject cms)	Creates a new instance.
CmsFavoriteDAO(CmsObject cms, String userName)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
List<CmsFavoriteEntry>	loadFavorites()	Loads the favorite list.
void	saveFavorites(List<CmsFavoriteEntry> favorites)	Saves the favorites.

Methods inherited from class java.lang.Object

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

Field Details

ADDINFO_KEY

public static final String ADDINFO_KEY

The additional info key under which the favorites for a user are saved.

See Also:

• Constant Field Values

BASE_KEY

public static final String BASE_KEY

The main key in the JSON object containing the favorites.

See Also:

• Constant Field Values

Constructor Details

CmsFavoriteDAO

public CmsFavoriteDAO(CmsObject cms)
               throws CmsException

Creates a new instance.

Parameters:

cms - the CMS Context

Throws:

CmsException - if something goes wrong

CmsFavoriteDAO

public CmsFavoriteDAO(CmsObject cms,
 String userName)
               throws CmsException

Creates a new instance.

Parameters:

cms - the CMS Context

userName - the name of the user in whose additional infos the bookmarks are stored

Throws:

CmsException - if something goes wrong

Method Details

loadFavorites

public List<CmsFavoriteEntry> loadFavorites()
                                     throws CmsException

Loads the favorite list.

Returns:

the list of favorites

Throws:

CmsException - if something goes wrong

saveFavorites

public void saveFavorites(List<CmsFavoriteEntry> favorites)
                   throws CmsException

Saves the favorites.

Parameters:

favorites - the list of favorites to save

Throws:

CmsException - if something goes wrong