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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List	DEFAULT_SORT_PROPS

Method Summary

Methods

Modifier and Type	Method and Description
PersonFavourite	addFavourite(java.lang.String userName, org.alfresco.service.cmr.repository.NodeRef nodeRef) Add the entity identified by nodeRef as a favourite for user "userName".
PersonFavourite	getFavourite(java.lang.String userName, org.alfresco.service.cmr.repository.NodeRef nodeRef) Get a specific favourite for user "userName".
org.alfresco.query.PagingResults	getPagedFavourites(java.lang.String userName, java.util.Set types, java.util.List sortProps, org.alfresco.query.PagingRequest pagingRequest) A paged list of favourites for user "userName".
FavouritesService.Type	getType(org.alfresco.service.cmr.repository.NodeRef nodeRef)
boolean	isFavourite(java.lang.String userName, org.alfresco.service.cmr.repository.NodeRef nodeRef) Is the entity identified by nodeRef a favourite document of user "userName".
boolean	removeFavourite(java.lang.String userName, org.alfresco.service.cmr.repository.NodeRef nodeRef) Remove the document identified by nodeRef as a favourite for user "userName".

Field Detail

DEFAULT_SORT_PROPS

static final java.util.List DEFAULT_SORT_PROPS

Method Detail

getType

FavouritesService.Type getType(org.alfresco.service.cmr.repository.NodeRef nodeRef)

addFavourite

@Auditable(parameters={"userName", "nodeRef"})
PersonFavourite addFavourite(java.lang.String userName,
                                     org.alfresco.service.cmr.repository.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 -

nodeRef -

Returns:

isFavourite

@Auditable(parameters={"userName", "nodeRef"})
boolean isFavourite(java.lang.String userName,
                            org.alfresco.service.cmr.repository.NodeRef nodeRef)

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

Parameters:

userName -

nodeRef -

Returns:

removeFavourite

@Auditable(parameters={"userName", "nodeRef"})
boolean removeFavourite(java.lang.String userName,
                                org.alfresco.service.cmr.repository.NodeRef nodeRef)

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

Parameters:

userName -

nodeRef -

Returns:

getPagedFavourites

@Auditable(parameters={"userName", "types", "pagingRequest"})
org.alfresco.query.PagingResults getPagedFavourites(java.lang.String userName,
                                                            java.util.Set types,
                                                            java.util.List sortProps,
                                                            org.alfresco.query.PagingRequest pagingRequest)

A paged list of favourites for user "userName".

Parameters:

userName -

types -

sortProps -

pagingRequest -

Returns:

getFavourite

@Auditable(parameters={"userName", "nodeRef"})
PersonFavourite getFavourite(java.lang.String userName,
                                     org.alfresco.service.cmr.repository.NodeRef nodeRef)

Get a specific favourite for user "userName".

Parameters:

userName -

nodeRef -

Returns: