001/*
002 *  Copyright 2019 Anyware Services
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 */
016package org.ametys.web.indexing.solr.page.attachment;
017
018import java.util.Collection;
019
020import org.ametys.web.repository.page.Page;
021
022/**
023 * An interface for implementations which want to index the ids of the visible attachments of a {@link Page}.
024 */
025public interface PageVisibleAttachmentIndexer
026{
027    /**
028     * Retrieves the ids of the visible page attachments to index
029     * @param page The page
030     * @return the ids of the visible page attachments to index
031     */
032    Collection<String> getVisibleAttachmentIds(Page page);
033}
034