Package org.alfresco.rest.api.impl
Class FavouritesImpl
java.lang.Object
org.alfresco.rest.api.impl.FavouritesImpl
- All Implemented Interfaces:
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 -
Method Summary
Modifier and TypeMethodDescriptionaddFavourite
(String personId, Favourite favourite) Add a favourite for user personIdaddFavourite
(String personId, Favourite favourite, Parameters parameters) Add a favourite for user personId taking parameters into accountgetFavourite
(String personId, String favouriteId) Get a specific favourite for user personIdgetFavourite
(String personId, String favouriteId, Parameters parameters) Get a specific favourite for user personId taking parameters into accountgetFavourites
(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
(FavouritesService favouritesService) void
setNamespaceService
(org.alfresco.service.namespace.NamespaceService namespaceService) void
void
void
void
setSiteService
(SiteService siteService)
-
Constructor Details
-
FavouritesImpl
public FavouritesImpl()
-
-
Method Details
-
setPeople
-
setSites
-
setNodes
-
setFavouritesService
-
setSiteService
-
setNamespaceService
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService) -
addFavourite
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
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
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
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
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
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
-