mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
22d2935235
107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
107413: Merged DEV to 5.0.N (5.0.3)
106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Cleaning of Javadoc,
107565: MNT-13545 Fix compilation after merge of Javadoc
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
49 lines
1.5 KiB
Java
49 lines
1.5 KiB
Java
package org.alfresco.rest.api;
|
|
|
|
import org.alfresco.rest.api.model.Favourite;
|
|
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
|
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
|
|
|
/**
|
|
* Centralises access to favourites functionality and maps between representations repository and api representations.
|
|
*
|
|
* @author steveglover
|
|
* @since publicapi1.0
|
|
*/
|
|
public interface Favourites
|
|
{
|
|
/**
|
|
* Add a favourite for user personId
|
|
*
|
|
* @param personId the personId for which the favourite is to be added
|
|
* @param favourite the favourite to add
|
|
*/
|
|
Favourite addFavourite(String personId, Favourite favourite);
|
|
|
|
/**
|
|
* Add a favourite for user personId
|
|
*
|
|
* @param personId the personId for which the favourite is to be removed
|
|
* @param id the id of the favourite to remove (id is a uuid)
|
|
*/
|
|
void removeFavourite(String personId, String id);
|
|
|
|
/**
|
|
* Get a paged list of favourites for user personId
|
|
*
|
|
* @param personId the personId for which the favourite is to be removed
|
|
* @param parameters Parameters
|
|
* @return paged favourites
|
|
*/
|
|
CollectionWithPagingInfo<Favourite> getFavourites(String personId, final Parameters parameters);
|
|
|
|
/**
|
|
* Get a specific favourite for user personId
|
|
*
|
|
* @param personId the personId for which the favourite is to be removed
|
|
* @param favouriteId the favourite id
|
|
* @return the favourite
|
|
*/
|
|
Favourite getFavourite(String personId, String favouriteId);
|
|
}
|