001/*
002 * (C) Copyright 2006-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 */
017package org.nuxeo.ecm.platform.preview.api;
018
019import java.util.List;
020
021import org.nuxeo.ecm.core.api.Blob;
022import org.nuxeo.ecm.core.api.DocumentModel;
023
024/**
025 * Interface for the Preview DocumentModel adapter.
026 *
027 * @author tiry
028 */
029public interface HtmlPreviewAdapter {
030
031    boolean cachable();
032
033    String getFilePreviewURL();
034
035    String getFilePreviewURL(String xpath);
036
037    List<Blob> getFilePreviewBlobs() throws PreviewException;
038
039    List<Blob> getFilePreviewBlobs(String xpath) throws PreviewException;
040
041    List<Blob> getFilePreviewBlobs(boolean postProcess) throws PreviewException;
042
043    List<Blob> getFilePreviewBlobs(String xpath, boolean postProcess) throws PreviewException;
044
045    void setAdaptedDocument(DocumentModel doc);
046
047    void cleanup();
048
049    /**
050     * Check if the document holds some blobs that are suitable for preview
051     *
052     * @return
053     * @throws PreviewException
054     * @since 5.7.3
055     */
056    boolean hasBlobToPreview() throws PreviewException;
057
058    /**
059     * @since 8.2
060     */
061    boolean hasPreview(String xpath);
062
063}