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