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 Modifier and Type Field Description static java.lang.String
PARAM_INCLUDE_PATH
static java.lang.String
PARAM_INCLUDE_PROPERTIES
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Favourite
addFavourite(java.lang.String personId, Favourite favourite)
Add a favourite for user personIdFavourite
addFavourite(java.lang.String personId, Favourite favourite, Parameters parameters)
Add a favourite for user personId taking parameters into accountFavourite
getFavourite(java.lang.String personId, java.lang.String favouriteId)
Get a specific favourite for user personIdFavourite
getFavourite(java.lang.String personId, java.lang.String favouriteId, Parameters parameters)
Get a specific favourite for user personId taking parameters into accountCollectionWithPagingInfo<Favourite>
getFavourites(java.lang.String personId, Parameters parameters)
Get a paged list of favourites for user personIdvoid
removeFavourite(java.lang.String personId, java.lang.String id)
Add a favourite for user personId
-
-
-
Field Detail
-
PARAM_INCLUDE_PATH
static final java.lang.String PARAM_INCLUDE_PATH
- See Also:
- Constant Field Values
-
PARAM_INCLUDE_PROPERTIES
static final java.lang.String PARAM_INCLUDE_PROPERTIES
- See Also:
- Constant Field Values
-
-
Method Detail
-
addFavourite
Favourite addFavourite(java.lang.String personId, Favourite favourite)
Add a favourite for user personId- Parameters:
personId
- the personId for which the favourite is to be addedfavourite
- the favourite to add
-
addFavourite
Favourite addFavourite(java.lang.String personId, Favourite favourite, Parameters parameters)
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
void removeFavourite(java.lang.String personId, java.lang.String id)
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
CollectionWithPagingInfo<Favourite> getFavourites(java.lang.String personId, Parameters parameters)
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
Favourite getFavourite(java.lang.String personId, java.lang.String favouriteId)
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
Favourite getFavourite(java.lang.String personId, java.lang.String favouriteId, Parameters parameters)
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
-
-