senselogic.sitevision.api.bookmark

Interface BookmarkUtil

@Requireable(value="BookmarkUtil")
public interface BookmarkUtil

Bookmark utility interface. Bookmarks are potentially clustered between sitevision instances. All altering methods in this class are synchronized.

Note: Does NOT work for anonymous users!

An instance of the Sitevision class implementing this interface can be obtained via Utils.getBookmarkUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 2.6.1

Author:

Mikael Wikblom

Method Summary

Modifier and Type	Method and Description
void	add(Node bookmark) Adds a bookmark for the current user.
void	add(Node bookmark, String categories) Deprecated. Use add(javax.jcr.Node), categories will be resolved from metadata.
boolean	contains(Node bookmark) Checks if the current user has the provided bookmark
List<Node>	getBookmarks() Returns a list of Node objects for all bookmarks belonging to the current user regardless of category.
List<Node>	getBookmarks(String category) Returns a list of Node objects corresponding to the bookmarks for the current user and the provided categories.
boolean	getLimitNofBookmarks() Accesses a boolean indicating if the current site has a limited number of bookmarks.
int	getMaxNofBookmarks() Accessor to max number of bookmarks for the current site.
void	remove(Node bookmark) Removes a bookmark for the current user.

Method Detail

getBookmarks

List<Node> getBookmarks()

Returns a list of Node objects for all bookmarks belonging to the current user regardless of category. This method only returns valid bookmarks (existing, published objects)

Returns:

a list of bookmark nodes. Is never null

getBookmarks

List<Node> getBookmarks(String category)

Returns a list of Node objects corresponding to the bookmarks for the current user and the provided categories. This method only returns valid bookmarks (existing, published objects)

Parameters:

category - a comma separated list of categories or null for no category

Returns:

a list of bookmark nodes. Is never null

add

@Deprecated
void add(Node bookmark,
                     String categories)

Deprecated. Use add(javax.jcr.Node), categories will be resolved from metadata.

Adds a bookmark for the current user. This operation is synchronized

Parameters:

bookmark - the node to be bookmarked must be a sv:page, sv:sitePage or an sv:article

categories - a comma separated list of categories to where this bookmark belongs

Throws:

IllegalArgumentException - if bookmark is node of wrong type

NullPointerException - if bookmark is null

add

void add(Node bookmark)

Adds a bookmark for the current user. This operation is synchronized

Parameters:

bookmark - the node to be bookmarked must be a sv:page, sv:sitePage or an sv:article

Throws:

IllegalArgumentException - if bookmark is node of wrong type

NullPointerException - if bookmark is null

remove

void remove(Node bookmark)

Removes a bookmark for the current user. This operation is synchronized

Parameters:

bookmark - the bookmark

Throws:

NullPointerException - if bookmark is null

contains

boolean contains(Node bookmark)

Checks if the current user has the provided bookmark

Parameters:

bookmark - the bookmark

Returns:

if the user has provided bookmark

Throws:

NullPointerException - if bookmark is null

getLimitNofBookmarks

boolean getLimitNofBookmarks()

Accesses a boolean indicating if the current site has a limited number of bookmarks. To get the max number of bookmarks, use getMaxNofBookmarks().

Returns:

a boolean indicating if the current site has a limited number of bookmarks

Throws:

NullPointerException - if current site is indeterminable

Since:

Sitevision 2.6.1_01

See Also:

getMaxNofBookmarks()

getMaxNofBookmarks

int getMaxNofBookmarks()

Accessor to max number of bookmarks for the current site.

Returns:

max number of bookmarks for the current site

Throws:

NullPointerException - if current site is indeterminable

Since:

Sitevision 2.6.1_01

See Also:

getLimitNofBookmarks()