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 org.nuxeo.ecm.core.api.DocumentModel;
023
024/**
025 * @author <a href="mailto:glefter@nuxeo.com">George Lefter</a>
026 */
027public interface CommentConverter {
028
029    /**
030     * Transforms the comment object into the document model.
031     */
032    void updateDocumentModel(DocumentModel docModel, DocumentModel comment);
033
034    /**
035     * Returns the type for comment document models.
036     */
037    String getDocumentType();
038
039}