001/*
002 * (C) Copyright 2018 Nuxeo (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 *     Guillaume Renard <[email protected]>
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 10.3
026 */
027public interface CollectionLocationService {
028
029    /**
030     * Provide the default document where will be stored collections. The document must be a "Folderish" accepting
031     * "Collection" sub-type.
032     *
033     * @param session the core session
034     * @return the default location for collections
035     */
036    DocumentModel getUserDefaultCollectionsRoot(CoreSession session);
037
038    /**
039     * Provide the default favorites document. The document must be of type Favorites.
040     *
041     * @param session the core session
042     * @return the favorites
043     */
044    DocumentModel getUserFavorites(CoreSession session);
045}