001/*
002 * (C) Copyright 2006-2012 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 *     Antoine Taillefer
018 */
019package org.nuxeo.ecm.diff.content;
020
021import java.util.List;
022import java.util.Locale;
023
024import org.nuxeo.ecm.core.api.Blob;
025import org.nuxeo.ecm.core.api.DocumentModel;
026import org.nuxeo.ecm.core.convert.api.ConversionException;
027import org.nuxeo.ecm.diff.content.adapter.base.ContentDiffConversionType;
028
029/**
030 * Interface for the content diff DocumentModel adapter.
031 *
032 * @author Antoine Taillefer
033 * @since 5.6
034 */
035public interface ContentDiffAdapter {
036
037    boolean cachable();
038
039    String getFileContentDiffURL(DocumentModel otherDoc, ContentDiffConversionType conversionType, String locale);
040
041    String getFileContentDiffURL(DocumentModel otherDoc, String xpath, ContentDiffConversionType conversionType,
042            String locale);
043
044    List<Blob> getFileContentDiffBlobs(DocumentModel otherDoc, ContentDiffConversionType conversionType, Locale locale)
045            throws ContentDiffException, ConversionException;
046
047    List<Blob> getFileContentDiffBlobs(DocumentModel otherDoc, String xpath, ContentDiffConversionType conversionType,
048            Locale locale) throws ContentDiffException, ConversionException;
049
050    void setAdaptedDocument(DocumentModel doc);
051
052    void cleanup();
053
054}