org.alfresco.rest.api.impl

Class FavouritesImpl

java.lang.Object

org.alfresco.rest.api.impl.FavouritesImpl

All Implemented Interfaces:

Favourites

public class FavouritesImpl
extends Object
implements Favourites

Public REST API: Centralises access to favourites functionality and maps between representations repository and api representations.

Since:

publicapi1.0

Author:

steveglover

Field Summary

Fields inherited from interface org.alfresco.rest.api.Favourites

PARAM_INCLUDE_PATH

Constructor Summary

Constructors

Constructor and Description
FavouritesImpl()

Method Summary

Modifier and Type	Method and Description
Favourite	addFavourite(String personId, Favourite favourite) Add a favourite for user personId
Favourite	addFavourite(String personId, Favourite favourite, Parameters parameters) Add a favourite for user personId taking parameters into account
Favourite	getFavourite(String personId, String favouriteId) Get a specific favourite for user personId
Favourite	getFavourite(String personId, String favouriteId, Parameters parameters) Get a specific favourite for user personId taking parameters into account
CollectionWithPagingInfo<Favourite>	getFavourites(String personId, Parameters parameters) Get a paged list of favourites for user personId
void	removeFavourite(String personId, String id) Add a favourite for user personId
void	setFavouritesService(FavouritesService favouritesService)
void	setNodes(Nodes nodes)
void	setPeople(People people)
void	setSites(Sites sites)
void	setSiteService(SiteService siteService)

Methods inherited from class java.lang.Object

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

Constructor Detail

FavouritesImpl

public FavouritesImpl()

Method Detail

setPeople

public void setPeople(People people)

setSites

public void setSites(Sites sites)

setNodes

public void setNodes(Nodes nodes)

setFavouritesService

public void setFavouritesService(FavouritesService favouritesService)

setSiteService

public void setSiteService(SiteService siteService)

addFavourite

public Favourite addFavourite(String personId,
                              Favourite favourite)

Description copied from interface: Favourites

Add a favourite for user personId

Specified by:

addFavourite in interface Favourites

Parameters:

personId - the personId for which the favourite is to be added

favourite - the favourite to add

addFavourite

public Favourite addFavourite(String personId,
                              Favourite favourite,
                              Parameters parameters)

Description copied from interface: Favourites

Add a favourite for user personId taking parameters into account

Specified by:

addFavourite in interface Favourites

Parameters:

personId - the personId for which the favourite is to be added

favourite - the favourite to add

parameters - the parameters

removeFavourite

public void removeFavourite(String personId,
                            String id)

Description copied from interface: Favourites

Add a favourite for user personId

Specified by:

removeFavourite in interface Favourites

Parameters:

personId - the personId for which the favourite is to be removed

id - the id of the favourite to remove (id is a uuid)

getFavourite

public Favourite getFavourite(String personId,
                              String favouriteId)

Description copied from interface: Favourites

Get a specific favourite for user personId

Specified by:

getFavourite in interface Favourites

Parameters:

personId - the personId for which the favourite is to be removed

favouriteId - the favourite id

Returns:

the favourite

getFavourite

public Favourite getFavourite(String personId,
                              String favouriteId,
                              Parameters parameters)

Description copied from interface: Favourites

Get a specific favourite for user personId taking parameters into account

Specified by:

getFavourite in interface Favourites

Parameters:

personId - the personId for which the favourite is to be removed

favouriteId - the favourite id

parameters - the parameters

Returns:

the favourite

getFavourites

public CollectionWithPagingInfo<Favourite> getFavourites(String personId,
                                                         Parameters parameters)

Description copied from interface: Favourites

Get a paged list of favourites for user personId

Specified by:

getFavourites in interface Favourites

Parameters:

personId - the personId for which the favourite is to be removed

parameters - Parameters

Returns:

paged favourites