Package org.opencms.gwt

Class CmsUsedCategoriesList

java.lang.Object

org.opencms.gwt.CmsUsedCategoriesList

public class CmsUsedCategoriesList
extends Object

Represents a list of recently used categories for a given user.

You can add categories to this or truncate the list to the n most recently used categories, as well as serialize it to or deserialize it from JSON.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDINFO_USED_CATEGORIES	Additional info key used to store used categories for users.
static final String	CONF_USED_CATEGORIES_LIMIT	Configuration option used to change the maximum number of entries to keep per user.
static final int	USED_CATEGORIES_LIMIT	Default limit for storing used categories.

Constructor Summary

Constructors

Constructor	Description
CmsUsedCategoriesList()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	add(String category)	Adds a new category entry.
static void	addUsedCategoryForCurrentUser(CmsObject cms, String category)	Stores a used category for the current user.
static CmsUsedCategoriesList	fromJson(String json)	Deserializes a used categories list from JSON.
Set<String>	getCategories()	Gets the categories as a set.
void	limit(int maxEntries)	Removes all but the last 'maxEntries' entries if there are more entries than that.
String	toJson()	Converts the list to JSON.

Methods inherited from class java.lang.Object

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

Field Details

ADDINFO_USED_CATEGORIES

public static final String ADDINFO_USED_CATEGORIES

Additional info key used to store used categories for users.

See Also:

• Constant Field Values

CONF_USED_CATEGORIES_LIMIT

public static final String CONF_USED_CATEGORIES_LIMIT

Configuration option used to change the maximum number of entries to keep per user.

See Also:

• Constant Field Values

USED_CATEGORIES_LIMIT

public static final int USED_CATEGORIES_LIMIT

Default limit for storing used categories.

See Also:

• Constant Field Values

Constructor Details

CmsUsedCategoriesList

public CmsUsedCategoriesList()

Creates a new instance.

Method Details

addUsedCategoryForCurrentUser

public static void addUsedCategoryForCurrentUser(CmsObject cms,
 String category)
                                          throws CmsException

Stores a used category for the current user.

Parameters:

cms - the current CMS context

category - the category to store

Throws:

CmsException - if something goes wrong

fromJson

public static CmsUsedCategoriesList fromJson(String json)

Deserializes a used categories list from JSON.

Parameters:

json - the JSON representation

Returns:

the used categories list

add

public void add(String category)

Adds a new category entry.

If the category is already part of this list, it is moved to the end of the list.

Parameters:

category - the category to add

getCategories

public Set<String> getCategories()

Gets the categories as a set.

Returns:

the categories

limit

public void limit(int maxEntries)

Removes all but the last 'maxEntries' entries if there are more entries than that.

Parameters:

maxEntries - the numer of entries to keep

toJson

public String toJson()

Converts the list to JSON.

Returns:

the JSON representation for this list