001/*
002 * (C) Copyright 2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Nuxeo - initial API and implementation
016 *
017 * $Id$
018 */
019
020package org.nuxeo.ecm.platform.comment.api;
021
022import java.io.Serializable;
023import java.util.List;
024
025import org.nuxeo.ecm.core.api.DocumentModel;
026
027/**
028 * @author <a href="mailto:glefter@nuxeo.com">George Lefter</a>
029 */
030public interface CommentableDocument extends Serializable {
031
032    /**
033     * Returns all comments for this document.
034     *
035     * @return the list of comments
036     */
037    List<DocumentModel> getComments();
038
039    /**
040     * Returns the comments for this document that are replied to a parent comment.
041     *
042     * @param parent the parent comment
043     * @return the comments for the parent comment
044     */
045    List<DocumentModel> getComments(DocumentModel parent);
046
047    /**
048     * Removes a comment from the document comment list.
049     *
050     * @param comment
051     */
052    void removeComment(DocumentModel comment);
053
054    /**
055     * Creates a new comment.
056     *
057     * @param comment
058     */
059    DocumentModel addComment(DocumentModel comment);
060
061    /**
062     * Creates a new comment as a reply to an existing comment.
063     *
064     * @param parent the parent comment, which must exist
065     * @param comment the comment to be added
066     */
067    DocumentModel addComment(DocumentModel parent, DocumentModel comment);
068
069}