Package 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, PARAM_INCLUDE_PROPERTIES
-
-
Constructor Summary
Constructors Constructor Description FavouritesImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Favourite
addFavourite(String personId, Favourite favourite)
Add a favourite for user personIdFavourite
addFavourite(String personId, Favourite favourite, Parameters parameters)
Add a favourite for user personId taking parameters into accountFavourite
getFavourite(String personId, String favouriteId)
Get a specific favourite for user personIdFavourite
getFavourite(String personId, String favouriteId, Parameters parameters)
Get a specific favourite for user personId taking parameters into accountCollectionWithPagingInfo<Favourite>
getFavourites(String personId, Parameters parameters)
Get a paged list of favourites for user personIdvoid
removeFavourite(String personId, String id)
Add a favourite for user personIdvoid
setFavouritesService(org.alfresco.service.cmr.favourites.FavouritesService favouritesService)
void
setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void
setNodes(Nodes nodes)
void
setPeople(People people)
void
setSites(Sites sites)
void
setSiteService(org.alfresco.service.cmr.site.SiteService siteService)
-
-
-
Method Detail
-
setPeople
public void setPeople(People people)
-
setSites
public void setSites(Sites sites)
-
setNodes
public void setNodes(Nodes nodes)
-
setFavouritesService
public void setFavouritesService(org.alfresco.service.cmr.favourites.FavouritesService favouritesService)
-
setSiteService
public void setSiteService(org.alfresco.service.cmr.site.SiteService siteService)
-
setNamespaceService
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
-
addFavourite
public Favourite addFavourite(String personId, Favourite favourite)
Description copied from interface:Favourites
Add a favourite for user personId- Specified by:
addFavourite
in interfaceFavourites
- Parameters:
personId
- the personId for which the favourite is to be addedfavourite
- 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 interfaceFavourites
- Parameters:
personId
- the personId for which the favourite is to be addedfavourite
- the favourite to addparameters
- 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 interfaceFavourites
- Parameters:
personId
- the personId for which the favourite is to be removedid
- 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 interfaceFavourites
- Parameters:
personId
- the personId for which the favourite is to be removedfavouriteId
- 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 interfaceFavourites
- Parameters:
personId
- the personId for which the favourite is to be removedfavouriteId
- the favourite idparameters
- 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 interfaceFavourites
- Parameters:
personId
- the personId for which the favourite is to be removedparameters
- Parameters- Returns:
- paged favourites
-
-