001/*
002 * (C) Copyright 2007 Nuxeo SA (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 *     Nuxeo - initial API and implementation
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.platform.comment.api;
023
024import org.nuxeo.ecm.core.api.DocumentModel;
025
026/**
027 * @author <a href="mailto:glefter@nuxeo.com">George Lefter</a>
028 */
029public interface CommentConverter {
030
031    /**
032     * Transforms the comment object into the document model.
033     */
034    void updateDocumentModel(DocumentModel docModel, DocumentModel comment);
035
036    /**
037     * Returns the type for comment document models.
038     */
039    String getDocumentType();
040
041}