Package org.alfresco.service.cmr.favourites

Interface FavouritesService

All Known Implementing Classes:

FavouritesServiceImpl

public interface FavouritesService

A service for managing a person's favourites. Currently supports favouriting of sites, files and folders.

Author:

steveglover

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FavouritesService.SortFields
static class	FavouritesService.Type

Field Summary

Fields

Modifier and Type	Field	Description
static List<Pair<FavouritesService.SortFields,Boolean>>	DEFAULT_SORT_PROPS

Method Summary

Modifier and Type	Method	Description
PersonFavourite	addFavourite(String userName, NodeRef nodeRef)	Add the entity identified by nodeRef as a favourite for user "userName".
PersonFavourite	getFavourite(String userName, NodeRef nodeRef)	Get a specific favourite for user "userName".
PagingResults<PersonFavourite>	getPagedFavourites(String userName, Set<FavouritesService.Type> types, List<Pair<FavouritesService.SortFields,Boolean>> sortProps, PagingRequest pagingRequest)	A paged list of favourites for user "userName".
FavouritesService.Type	getType(NodeRef nodeRef)
boolean	isFavourite(String userName, NodeRef nodeRef)	Is the entity identified by nodeRef a favourite document of user "userName".
boolean	removeFavourite(String userName, NodeRef nodeRef)	Remove the document identified by nodeRef as a favourite for user "userName".

Field Detail

DEFAULT_SORT_PROPS

static final List<Pair<FavouritesService.SortFields,Boolean>> DEFAULT_SORT_PROPS

Method Detail

getType

FavouritesService.Type getType(NodeRef nodeRef)

addFavourite

@Auditable(parameters={"userName","nodeRef"})
PersonFavourite addFavourite(String userName,
                             NodeRef nodeRef)

Add the entity identified by nodeRef as a favourite for user "userName". If the nodeRef is already favourited, the favourite entity is returned. No information regarding the favourite e.g. createdAt is updated.

Parameters:

userName - String

nodeRef - NodeRef

Returns:

PersonFavourite

isFavourite

@Auditable(parameters={"userName","nodeRef"})
boolean isFavourite(String userName,
                    NodeRef nodeRef)

Is the entity identified by nodeRef a favourite document of user "userName".

Parameters:

userName - String

nodeRef - NodeRef

Returns:

boolean

removeFavourite

@Auditable(parameters={"userName","nodeRef"})
boolean removeFavourite(String userName,
                        NodeRef nodeRef)

Remove the document identified by nodeRef as a favourite for user "userName".

Parameters:

userName - String

nodeRef - NodeRef

Returns:

boolean

getPagedFavourites

@Auditable(parameters={"userName","types","pagingRequest"})
PagingResults<PersonFavourite> getPagedFavourites(String userName,
                                                  Set<FavouritesService.Type> types,
                                                  List<Pair<FavouritesService.SortFields,Boolean>> sortProps,
                                                  PagingRequest pagingRequest)

A paged list of favourites for user "userName".

Parameters:

userName - String

pagingRequest - PagingRequest

getFavourite

@Auditable(parameters={"userName","nodeRef"})
PersonFavourite getFavourite(String userName,
                             NodeRef nodeRef)

Get a specific favourite for user "userName".

Parameters:

userName - String

nodeRef - NodeRef

Returns:

PersonFavourite