001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
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 *     Thomas Roger <troger@nuxeo.com>
016 */
017
018package org.nuxeo.ecm.core.api.quota;
019
020/**
021 * Adapter giving statistics about a given {@link org.nuxeo.ecm.core.api.DocumentModel}.
022 *
023 * @author <a href="mailto:troger@nuxeo.com">Thomas Roger</a>
024 * @since 5.5
025 */
026public interface QuotaStats {
027
028    /**
029     * Returns the intrinsic cardinal value of the underlying document.
030     */
031    long getIntrinsic();
032
033    /**
034     * Returns the cardinal value of all the children of the underlying document.
035     */
036    long getChildren();
037
038    /**
039     * Returns the cardinal value of all the descendants of the underlying document. plus the value of
040     * {@link #getIntrinsic()}.
041     */
042    long getTotal();
043
044}