/*
 * Copyright (C) 2005-2009 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */
package org.alfresco.cmis;

import java.util.List;

/**
 * An Access control report.
 * This is an ACL.
 * 
 * @author andyh
 *
 */
public interface CMISAccessControlReport
{
    /**
     * Get the list of ACEs.
     * @return the list of ACEs.
     */
    public List<? extends CMISAccessControlEntry> getAccessControlEntries();
    
    /**
     * Is this report incomplete?
     * If so there are other other security constraints that apply
     * 
     * @return <code>false</code> means the report fully describes security access, <code>true</code> means other
     * security constraints apply but are not reported. 
     */
    public boolean isExtract();
    
    /**
     * Get ACEs grouped by principal id
     * @return
     */
    public List<? extends CMISAccessControlEntriesGroupedByPrincipalId> getAccessControlEntriesGroupedByPrincipalId();
    
    
}