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 *     Nuxeo - initial API and implementation
018 *
019 */
020package org.nuxeo.ecm.platform.audit.api;
021
022import java.util.List;
023
024import org.nuxeo.ecm.core.api.DocumentModel;
025import org.nuxeo.ecm.platform.query.api.PageProvider;
026
027/**
028 * Dedicated interface to browse history of a document
029 *
030 * @author <a href="mailto:[email protected]">Tiry</a>
031 */
032public interface DocumentHistoryReader {
033
034    /**
035     * Retrieve a page of {@link LogEntry} for the history of the input {@link DocumentModel}
036     *
037     * @param doc
038     * @param pageIndex
039     * @param pageSize
040     * @return
041     */
042    List<LogEntry> getDocumentHistory(DocumentModel doc, long pageIndex, long pageSize);
043
044    /**
045     * Retrieve the {@link PageProvider} of {@link LogEntry} for the history of the input {@link DocumentModel}
046     *
047     * @param doc
048     * @param pageIndex
049     * @param pageSize
050     * @return
051     */
052    PageProvider<LogEntry> getPageProvider(DocumentModel doc, long pageIndex, long pageSize);
053}