org.exoplatform.services.cms.documents

Interface FavoriteService

public interface FavoriteService

Manages favorites of users.

Level API:

Experimental

Method Summary

Methods

Modifier and Type	Method and Description
void	addFavorite(javax.jcr.Node node, String userName) Adds favorite to a node.
List<javax.jcr.Node>	getAllFavoriteNodesByUser(String workspace, String repository, String userName) Gets all favorite nodes by a given user.
boolean	isFavoriter(String userName, javax.jcr.Node node) Checks if a node is in favorite list of a given user.
void	removeFavorite(javax.jcr.Node node, String userName) Removes favorite from a node.

Method Detail

addFavorite

void addFavorite(javax.jcr.Node node,
               String userName)
                 throws Exception

Adds favorite to a node.

Parameters:

node - The node to which favorite is added.

userName - The user who added favorite to the node.

Throws:

Exception - The exception will be raised if the node can not add mixin.

removeFavorite

void removeFavorite(javax.jcr.Node node,
                  String userName)
                    throws Exception

Removes favorite from a node.

Parameters:

node - The node from which favorite is removed.

userName - The user who removed favorite from the node.

Throws:

Exception

getAllFavoriteNodesByUser

List<javax.jcr.Node> getAllFavoriteNodesByUser(String workspace,
                                             String repository,
                                             String userName)
                                               throws Exception

Gets all favorite nodes by a given user.

Parameters:

workspace - The workspace from which the favorite nodes are got.

repository - The repository from which the favorite nodes are got.

userName - The user who added favorite.

Returns:

The favorite node added by the user.

Throws:

Exception

isFavoriter

boolean isFavoriter(String userName,
                  javax.jcr.Node node)
                    throws Exception

Checks if a node is in favorite list of a given user.

Parameters:

userName - The given user.

node - The node to be checked.

Throws:

Exception