Package org.alfresco.service.cmr.favourites

Interface FavouritesService

  • All Known Implementing Classes:
    FavouritesServiceImpl
    public interface FavouritesService
    A service for managing a person's favourites. Currently supports favouriting of sites, files and folders.
    Author:
    steveglover

    • Field Detail

      • DEFAULT_SORT_PROPS

        static final java.util.List<org.alfresco.util.Pair<FavouritesService.SortFields,​java.lang.Boolean>> DEFAULT_SORT_PROPS

    • Method Detail

      • addFavourite

        @Auditable(parameters={"userName","nodeRef"})
PersonFavourite addFavourite​(java.lang.String userName,
                             org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Add the entity identified by nodeRef as a favourite for user "userName". If the nodeRef is already favourited, the favourite entity is returned. No information regarding the favourite e.g. createdAt is updated.
        Parameters:
        userName - String
        nodeRef - NodeRef
        Returns:
        PersonFavourite

      • isFavourite

        @Auditable(parameters={"userName","nodeRef"})
boolean isFavourite​(java.lang.String userName,
                    org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Is the entity identified by nodeRef a favourite document of user "userName".
        Parameters:
        userName - String
        nodeRef - NodeRef
        Returns:
        boolean

      • removeFavourite

        @Auditable(parameters={"userName","nodeRef"})
boolean removeFavourite​(java.lang.String userName,
                        org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Remove the document identified by nodeRef as a favourite for user "userName".
        Parameters:
        userName - String
        nodeRef - NodeRef
        Returns:
        boolean

      • getPagedFavourites

        @Auditable(parameters={"userName","types","pagingRequest"})
org.alfresco.query.PagingResults<PersonFavourite> getPagedFavourites​(java.lang.String userName,
                                                                     java.util.Set<FavouritesService.Type> types,
                                                                     java.util.List<org.alfresco.util.Pair<FavouritesService.SortFields,​java.lang.Boolean>> sortProps,
                                                                     org.alfresco.query.PagingRequest pagingRequest)
        A paged list of favourites for user "userName".
        Parameters:
        userName - String
        pagingRequest - PagingRequest

      • getFavourite

        @Auditable(parameters={"userName","nodeRef"})
PersonFavourite getFavourite​(java.lang.String userName,
                             org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Get a specific favourite for user "userName".
        Parameters:
        userName - String
        nodeRef - NodeRef
        Returns:
        PersonFavourite