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 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id: ContentHistoryActions.java 25663 2007-10-04 11:54:15Z cbaican $
020 */
021
022package org.nuxeo.ecm.platform.audit.web.listener;
023
024import java.io.Serializable;
025import java.util.List;
026import java.util.Map;
027
028import org.nuxeo.ecm.core.api.DocumentModel;
029import org.nuxeo.ecm.core.api.SortInfo;
030import org.nuxeo.ecm.platform.audit.api.LogEntry;
031import org.nuxeo.ecm.platform.audit.api.comment.LinkedDocument;
032
033/**
034 * Content history actions business interface.
035 *
036 * @author <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
037 */
038public interface ContentHistoryActions extends Serializable {
039
040    /**
041     * Computes all log entries for current document.
042     */
043    List<? extends LogEntry> computeLogEntries();
044
045    /**
046     * Computes all log entries for given document.
047     */
048    List<? extends LogEntry> computeLogEntries(DocumentModel document);
049
050    /**
051     * Computes latest logs only.
052     */
053    List<? extends LogEntry> computeLatestLogEntries();
054
055    Map<Long, String> computeLogEntriesComments();
056
057    Map<Long, LinkedDocument> computeLogEntrieslinkedDocs();
058
059    /**
060     * Returns the log comment.
061     * <p>
062     * This log may be filled automatically when dealing with copy/paste/move log entries.
063     *
064     * @Deprecated This now handled by the PageProvider
065     */
066    @Deprecated
067    String getLogComment(LogEntry entry);
068
069    /**
070     * Returns the log linked document.
071     * <p>
072     * The linked document is resolved from the log original comment, when dealing with copy/paste/move log entries.
073     *
074     * @Deprecated This now handled by the PageProvider
075     */
076    @Deprecated
077    LinkedDocument getLogLinkedDocument(LogEntry entry);
078
079    String doSearch();
080
081    SortInfo getSortInfo();
082
083}