001/*
002 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     <a href="mailto:[email protected]">Guillaume</a>
018 */
019package org.nuxeo.ecm.collections.api;
020
021import org.nuxeo.ecm.core.api.CoreSession;
022import org.nuxeo.ecm.core.api.DocumentModel;
023
024/**
025 * @since 5.9.4
026 */
027public interface FavoritesManager {
028
029    void addToFavorites(final DocumentModel document, final CoreSession session);
030
031    boolean canAddToFavorites(final DocumentModel document);
032
033    /**
034     * @deprecated since 10.3 use {@link #getFavorites(CoreSession)} instead
035     */
036    @Deprecated
037    DocumentModel getFavorites(final DocumentModel context, final CoreSession session);
038
039    DocumentModel getFavorites(final CoreSession session);
040
041    boolean isFavorite(final DocumentModel document, final CoreSession session);
042
043    void removeFromFavorites(final DocumentModel document, final CoreSession session);
044
045}