001/*
002 * (C) Copyright 2013 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 *     Martin Pernollet
018 */
019
020package org.nuxeo.ecm.platform.groups.audit.service.acl;
021
022import org.nuxeo.ecm.core.api.CoreSession;
023import org.nuxeo.ecm.core.api.DocumentModel;
024import org.nuxeo.ecm.platform.groups.audit.service.acl.excel.IExcelBuilder;
025
026public interface IAclExcelLayoutBuilder {
027
028    /**
029     * Analyze and render an ACL audit for the complete repository in unrestricted mode.
030     */
031    public void renderAudit(CoreSession session);
032
033    /**
034     * Analyze and render an ACL audit for the complete document tree in unrestricted mode.
035     */
036    public void renderAudit(CoreSession session, DocumentModel doc);
037
038    /** Analyze and render an ACL audit for the input document and its children. */
039    public void renderAudit(CoreSession session, DocumentModel doc, boolean unrestricted);
040
041    public void renderAudit(CoreSession session, final DocumentModel doc, boolean unrestricted, int timeout);
042
043    public IExcelBuilder getExcel();
044
045}