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 Details

  • Method Details

    • addFavourite

      Favourite addFavourite(String personId, Favourite favourite)
      Add a favourite for user personId
      Parameters:
      personId - the personId for which the favourite is to be added
      favourite - the favourite to add

    • addFavourite

      Favourite addFavourite(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 added
      favourite - the favourite to add
      parameters - the parameters

    • removeFavourite

      void removeFavourite(String personId, String id)
      Add a favourite for user personId
      Parameters:
      personId - the personId for which the favourite is to be removed
      id - the id of the favourite to remove (id is a uuid)

    • getFavourites

      CollectionWithPagingInfo<Favourite> getFavourites(String personId, Parameters parameters)
      Get a paged list of favourites for user personId
      Parameters:
      personId - the personId for which the favourite is to be removed
      parameters - Parameters
      Returns:
      paged favourites

    • getFavourite

      Favourite getFavourite(String personId, String favouriteId)
      Get a specific favourite for user personId
      Parameters:
      personId - the personId for which the favourite is to be removed
      favouriteId - the favourite id
      Returns:
      the favourite

    • getFavourite

      Favourite getFavourite(String personId, 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 removed
      favouriteId - the favourite id
      parameters - the parameters
      Returns:
      the favourite