001/*
002 * (C) Copyright 2013 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl-2.1.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Martin Pernollet
016 */
017
018package org.nuxeo.ecm.platform.groups.audit.service.acl;
019
020import org.nuxeo.ecm.core.api.CoreSession;
021import org.nuxeo.ecm.core.api.DocumentModel;
022import org.nuxeo.ecm.platform.groups.audit.service.acl.excel.IExcelBuilder;
023
024public interface IAclExcelLayoutBuilder {
025
026    /**
027     * Analyze and render an ACL audit for the complete repository in unrestricted mode.
028     */
029    public void renderAudit(CoreSession session);
030
031    /**
032     * Analyze and render an ACL audit for the complete document tree in unrestricted mode.
033     */
034    public void renderAudit(CoreSession session, DocumentModel doc);
035
036    /** Analyze and render an ACL audit for the input document and its children. */
037    public void renderAudit(CoreSession session, DocumentModel doc, boolean unrestricted);
038
039    public void renderAudit(CoreSession session, final DocumentModel doc, boolean unrestricted, int timeout);
040
041    public IExcelBuilder getExcel();
042
043}