org.alfresco.repo.favourites

Class FavouritesServiceImpl

java.lang.Object

org.alfresco.repo.favourites.FavouritesServiceImpl

All Implemented Interfaces:

FavouritesService, org.springframework.beans.factory.InitializingBean

public class FavouritesServiceImpl
extends Object
implements FavouritesService, org.springframework.beans.factory.InitializingBean

Favourites service implementation that uses the PreferencesService for persisting favourites. Unfortunately, we are tied to the PreferencesService and to the preference names and data structure because Share uses the PreferenceService directly.

Author:

steveglover

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FavouritesServiceImpl.OnAddFavouritePolicy
static interface	FavouritesServiceImpl.OnRemoveFavouritePolicy

Nested classes/interfaces inherited from interface org.alfresco.service.cmr.favourites.FavouritesService

FavouritesService.SortFields, FavouritesService.Type

Field Summary

Fields inherited from interface org.alfresco.service.cmr.favourites.FavouritesService

DEFAULT_SORT_PROPS

Constructor Summary

Constructors

Constructor and Description
FavouritesServiceImpl()

Method Summary

Modifier and Type	Method and Description
PersonFavourite	addFavourite(String userName, org.alfresco.service.cmr.repository.NodeRef nodeRef) Add the entity identified by nodeRef as a favourite for user "userName".
void	afterPropertiesSet()
PersonFavourite	getFavourite(String userName, org.alfresco.service.cmr.repository.NodeRef nodeRef) Get a specific favourite for user "userName".
org.alfresco.query.PagingResults<PersonFavourite>	getPagedFavourites(String userName, Set<FavouritesService.Type> types, List<org.alfresco.util.Pair<FavouritesService.SortFields,Boolean>> sortProps, org.alfresco.query.PagingRequest pagingRequest) A paged list of favourites for user "userName".
FavouritesService.Type	getType(org.alfresco.service.cmr.repository.NodeRef nodeRef)
void	init()
boolean	isFavourite(String userName, org.alfresco.service.cmr.repository.NodeRef nodeRef) Is the entity identified by nodeRef a favourite document of user "userName".
boolean	removeFavourite(String userName, org.alfresco.service.cmr.repository.NodeRef nodeRef) Remove the document identified by nodeRef as a favourite for user "userName".
void	setAuthenticationContext(AuthenticationContext authenticationContext)
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setEventPublisher(org.alfresco.repo.events.EventPublisher eventPublisher)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
void	setPersonService(PersonService personService)
void	setPolicyComponent(PolicyComponent policyComponent)
void	setPreferenceService(PreferenceService preferenceService)
void	setSiteService(SiteService siteService)

Methods inherited from class java.lang.Object

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

Constructor Detail

FavouritesServiceImpl

public FavouritesServiceImpl()

Method Detail

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

setPersonService

public void setPersonService(PersonService personService)

setAuthenticationContext

public void setAuthenticationContext(AuthenticationContext authenticationContext)

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)

setSiteService

public void setSiteService(SiteService siteService)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setPreferenceService

public void setPreferenceService(PreferenceService preferenceService)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

init

public void init()

getType

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

Specified by:

getType in interface FavouritesService

addFavourite

public PersonFavourite addFavourite(String userName,
                                    org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: FavouritesService

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.

Specified by:

addFavourite in interface FavouritesService

Parameters:

userName - String

nodeRef - NodeRef

Returns:

PersonFavourite

removeFavourite

public boolean removeFavourite(String userName,
                               org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: FavouritesService

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

Specified by:

removeFavourite in interface FavouritesService

Parameters:

userName - String

nodeRef - NodeRef

Returns:

boolean

isFavourite

public boolean isFavourite(String userName,
                           org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: FavouritesService

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

Specified by:

isFavourite in interface FavouritesService

Parameters:

userName - String

nodeRef - NodeRef

Returns:

boolean

getPagedFavourites

public org.alfresco.query.PagingResults<PersonFavourite> getPagedFavourites(String userName,
                                                                            Set<FavouritesService.Type> types,
                                                                            List<org.alfresco.util.Pair<FavouritesService.SortFields,Boolean>> sortProps,
                                                                            org.alfresco.query.PagingRequest pagingRequest)

Description copied from interface: FavouritesService

A paged list of favourites for user "userName".

Specified by:

getPagedFavourites in interface FavouritesService

Parameters:

userName - String

pagingRequest - PagingRequest

getFavourite

public PersonFavourite getFavourite(String userName,
                                    org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: FavouritesService

Get a specific favourite for user "userName".

Specified by:

getFavourite in interface FavouritesService

Parameters:

userName - String

nodeRef - NodeRef

Returns:

PersonFavourite

setEventPublisher

public void setEventPublisher(org.alfresco.repo.events.EventPublisher eventPublisher)