Package org.alfresco.rest.api
Interface Favourites
- All Known Implementing Classes:
FavouritesImpl
public interface Favourites
Centralises access to favourites functionality and maps between representations repository and api representations.
- Since:
- publicapi1.0
- Author:
- steveglover
-
Field Summary
Fields -
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 personId
-
Field Details
-
PARAM_INCLUDE_PATH
- See Also:
-
PARAM_INCLUDE_PROPERTIES
- See Also:
-
-
Method Details
-
addFavourite
Add a favourite for user personId- Parameters:
personId
- the personId for which the favourite is to be addedfavourite
- the favourite to add
-
addFavourite
Add a favourite for user personId taking parameters into account- Parameters:
personId
- the personId for which the favourite is to be addedfavourite
- the favourite to addparameters
- the parameters
-
removeFavourite
Add a favourite for user personId- Parameters:
personId
- the personId for which the favourite is to be removedid
- the id of the favourite to remove (id is a uuid)
-
getFavourites
Get a paged list of favourites for user personId- Parameters:
personId
- the personId for which the favourite is to be removedparameters
- Parameters- Returns:
- paged favourites
-
getFavourite
Get a specific favourite for user personId- Parameters:
personId
- the personId for which the favourite is to be removedfavouriteId
- the favourite id- Returns:
- the favourite
-
getFavourite
Get a specific favourite for user personId taking parameters into account- Parameters:
personId
- the personId for which the favourite is to be removedfavouriteId
- the favourite idparameters
- the parameters- Returns:
- the favourite
-