001/*
002 *  Copyright 2018 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.plugins.repository.data.repositorydata;
017
018import java.util.List;
019
020import org.ametys.plugins.repository.data.DataComment;
021
022/**
023 * Interface for commentable data values management in repository
024 */
025public interface CommentableRepositoryData extends RepositoryData
026{
027    /**
028     * Retrieves the comments of the data stored in the repository with the given name
029     * @param name name of the data
030     * @return the list of {@link DataComment}
031     */
032    List<DataComment> getComments(String name);
033    
034    /**
035     * Indicates if the data stored in the repository with the given name has any comments
036     * @param name name of the data
037     * @return true if at least one comment exists for this data
038     */
039    boolean hasComments(String name);
040    
041    /**
042     * Indicates if the data stored in the repository with the given name has a comment
043     * @param name name of the data
044     * @param index the comment index
045     * @return true if a comment at this index exists for this data
046     */
047    boolean hasComment(String name, int index);
048}